GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Docs: Improved phrasing by aeros · Pull Request #14069 · python/cpython

Conversation

@aeros

@aeros aeros commented Jun 14, 2019

Copy link
Copy Markdown
Contributor

Summary: Removed usage of second person pronouns in the coding style section and made the assumption of "uneasiness" in transition between styles come across more neutrally. Also slightly improved the wording.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@aeros
Docs: Improved phrasing
9cc8e94
Removed usage of second person pronouns in the section and made the assumption of "uneasiness" in code style transition more neutral.
@the-knights-who-say-ni the-knights-who-say-ni added the CLA not signed label Jun 14, 2019
@bedevere-bot bedevere-bot added the docs Documentation in the Doc dir label Jun 14, 2019
@the-knights-who-say-ni

the-knights-who-say-ni commented Jun 14, 2019

Copy link
Copy Markdown

Hello, and thanks for your contribution!

I'm a bot set up to make sure that the project can legally accept your contribution by verifying you have signed the PSF contributor agreement (CLA).

Unfortunately we couldn't find an account corresponding to your GitHub username on bugs.python.org (b.p.o) to verify you have signed the CLA (this might be simply due to a missing "GitHub Name" entry in your b.p.o account settings). This is necessary for legal reasons before we can look at your contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

You can check yourself to see if the CLA has been received.

Thanks again for your contribution, we look forward to reviewing it!

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@bedevere-bot bedevere-bot added the awaiting review label Jun 14, 2019
@aeros

aeros commented Jun 14, 2019

Copy link
Copy Markdown
Contributor Author

Just created an account an bugs.python.org (made sure to specify github account name) and signed the PSF. Are the other components required for minor changes in the docs, or is that solely for code modifications?

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@willingc

willingc commented Jun 15, 2019

Copy link
Copy Markdown
Contributor

Hi @aeros167. Thanks for the PR. It looks as if the tests are failing on the documentation build due to trailing whitespace in line 34. Please review and update the PR.

When the tests all pass and the CLA status icon changes to signed (may take a few days), feel free to @-mention me and I'll take another look at the PR.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@willingc willingc added awaiting changes and removed awaiting review labels Jun 15, 2019
@the-knights-who-say-ni the-knights-who-say-ni added CLA signed and removed CLA not signed labels Jun 21, 2019
@aeros
Removed trailing whitespace on line 34
0ef0a34
@aeros

aeros commented Jun 21, 2019 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor Author

@willingc The CLA status is now approved. I hadn't realized that I needed to perform the CLA check manually in order for it to be updated on existing pull requests. Good to know for other projects which may have similar prerequisites.

I also removed the white space at the end of line 34. The only tests that aren't passing now are the labeling related tests, which likely wouldn't be relevant for small doc changes. Thanks for letting me know.

For future pull requests, was this one appropriately sized? I tried to avoid making it too small by improving parts of the section instead of a single sentence, but I didn't want to make changes across the entire doc for my first pull request to the project. I have some experience with writing/editing technical documentation, but I'm entirely new with contributing to large open source projects on GitHub. I've heard that smaller commits are generally preferable.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@willingc willingc added skip issue skip news labels Jun 21, 2019
@willingc
willingc merged commit d006800 into python:master Jun 21, 2019
@bedevere-bot bedevere-bot removed the awaiting changes label Jun 21, 2019
@willingc

willingc commented Jun 21, 2019

Copy link
Copy Markdown
Contributor

Thanks @aeros167 for the corrections and the PR. You are correct that smaller pull requests are generally favored. As an FYI the devguide has helpful sections on documentation and the development process. I encourage you to look at documentation issues on bugs.python.org as we would appreciate help with those issues. ☀️

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

CuriousLearner added a commit to CuriousLearner/cpython that referenced this pull request Jun 21, 2019
@CuriousLearner
Merge branch 'master' into fix-issue24255
7bf6445
* master: (599 commits)
  Docs: Improved phrasing (pythonGH-14069)
  Remove redundant if check from optional argument function in argparse. (pythonGH-8766)
  bpo-37289: Add a test for if with ifexpr in the peephole optimiser to detect regressions (pythonGH-14127)
  Update What's New in Python 3.9 (pythonGH-14253)
  bpo-36511: Improve ARM32 buildbot scripts (pythonGH-14251)
  bpo-37151: remove _PyCFunction_FastCallDict (pythonGH-14269)
  Fix typo, 'widger' -> 'widget', in idlelib/tree.py (pythonGH-14263)
  Fix bpo number in News file. (pythonGH-14260)
  bpo-37342: Fix the incorrect nb_index's type in typeobj documentation (pythonGH-14241)
  Update What's New in Python 3.8 (pythonGH-14239)
  bpo-36710: Use tstate in pylifecycle.c (pythonGH-14249)
  Add missing single quote in io.TextIOWrapper.reconfigure documentation (pythonGH-14246)
  bpo-36511: Add buildbot scripts and fix tests for Windows ARM32 buildbot (pythonGH-13454)
  bpo-37333: Ensure IncludeTkinter has a value (pythonGH-14240)
  bpo-37331: Clarify format of socket handler messages in the documentation. (pythonGH-14234)
  bpo-37258: Not a bug, but added a unit test and updated documentation. (pythonGH-14229)
  bpo-36710: Remove PyImport_Cleanup() function (pythonGH-14221)
  Fix name of '\0'. (pythonGH-14222)
  bpo-36710: Add tstate parameter in import.c (pythonGH-14218)
  Document typing.ForwardRef (pythonGH-14216)
  ...
@aeros aeros mentioned this pull request Aug 30, 2019
Enforce PEP 257 conventions in ftplib.py #15604
Merged
lisroach pushed a commit to lisroach/cpython that referenced this pull request Sep 10, 2019
@aeros @lisroach
Docs: Improved phrasing (pythonGH-14069)
828a02a
* Docs: Improved phrasing 

Removed usage of second person pronouns in the section and made the assumption of "uneasiness" in code style transition more neutral.

* Removed trailing whitespace on line 34
DinoV pushed a commit to DinoV/cpython that referenced this pull request Jan 14, 2020
@aeros @DinoV
Docs: Improved phrasing (pythonGH-14069)
af13bda
* Docs: Improved phrasing 

Removed usage of second person pronouns in the section and made the assumption of "uneasiness" in code style transition more neutral.

* Removed trailing whitespace on line 34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip issue skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

4 participants

@aeros @the-knights-who-say-ni @willingc @bedevere-bot
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402520 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.