Skip to content

bpo-25433: Streamline whitespace documentation#14775

Closed
rompe wants to merge 8 commits into
python:masterfrom
rompe:bgo-25433-streamline-whitespace-documentation
Closed

bpo-25433: Streamline whitespace documentation#14775
rompe wants to merge 8 commits into
python:masterfrom
rompe:bgo-25433-streamline-whitespace-documentation

Conversation

@rompe
Copy link
Copy Markdown

@rompe rompe commented Jul 14, 2019

Add a "whitespace" definition to the glossary and link to it from every documentation regarding whitespae.

As requested in bpo-25433, whitespace should be explained only once and all other places should point to this documentation instead of either explaining the term themselves or just stating "whitespace" without an explanation.

No NEWS entry added since this already comes with the code part in #14771 .

https://bugs.python.org/issue25433

Ulf Rompe added 6 commits July 14, 2019 12:59
Whenever the word "whitespace" was stated more than once within a single
section, I added the link to the first one only.
Whenever the word "whitespace" was stated more than once within a single
section, I added the link to the first one only.
@the-knights-who-say-ni
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).

Our records indicate we have not received your CLA. For legal reasons we need you to sign this before we can look at your contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

If you have recently signed the CLA, please wait at least one business day
before our records are updated.

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

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

@rompe rompe marked this pull request as ready for review July 14, 2019 13:16
@matrixise
Copy link
Copy Markdown
Member

Thank you @rompe for your contribution but could you fix the conflict with Doc/library/stdtypes.rst ?

Copy link
Copy Markdown
Member

@matrixise matrixise left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please, rebase with master and fix the conflicts.

@bedevere-bot
Copy link
Copy Markdown

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

@csabella
Copy link
Copy Markdown
Contributor

@rompe, please resolve the merge conflicts. Thanks!

@csabella
Copy link
Copy Markdown
Contributor

csabella commented Dec 1, 2019

This PR has been languishing while waiting for the merge conflicts to be resolved. I'm going to close this for now to allow someone else to pick it up. If the original author wishes to come back to it, then it can be reopened at that time. Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting changes docs Documentation in the Doc dir

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants