Skip to content

Update wording, links in key projects page#691

Merged
ncoghlan merged 18 commits intopypa:masterfrom
brainwane:key-projects-update
Feb 3, 2020
Merged

Update wording, links in key projects page#691
ncoghlan merged 18 commits intopypa:masterfrom
brainwane:key-projects-update

Conversation

@brainwane
Copy link
Copy Markdown
Contributor

A few link fixes, clearer explanations regarding wheel, packaging, pip, and distlib, and a few wording/capitalization fixes.

Comment thread source/key_projects.rst
Copy link
Copy Markdown
Member

@ncoghlan ncoghlan left a comment

Choose a reason for hiding this comment

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

Several suggestions inline. Perhaps it would make sense to split the purely mechanical GitHub word mark fix out from the more subjective updates to the project descriptions?

Comment thread source/key_projects.rst Outdated
Comment thread source/key_projects.rst
Comment thread source/key_projects.rst
Comment thread source/key_projects.rst
Comment thread source/key_projects.rst Outdated
Comment thread source/key_projects.rst Outdated
@brainwane
Copy link
Copy Markdown
Contributor Author

Several suggestions inline. Perhaps it would make sense to split the purely mechanical GitHub word mark fix out from the more subjective updates to the project descriptions?

I appreciate the note; if I'd been more disciplined I would have done that! If this PR drags on for several days then I'll probably do that. :-)

@brainwane brainwane requested a review from ncoghlan February 2, 2020 18:21
Copy link
Copy Markdown
Contributor

@bhrutledge bhrutledge left a comment

Choose a reason for hiding this comment

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

Thanks for asking for my review! Just some minor suggestions/questions, which I don't feel should block merging this.

Also, I couldn't make the sugestion, but http://docs.pipenv.org/ is an expired domain name. This works: https://pipenv.kennethreitz.org/en/latest/.

Comment thread source/key_projects.rst Outdated
Comment thread source/key_projects.rst
Comment thread source/key_projects.rst Outdated
Comment thread source/key_projects.rst Outdated
Comment thread source/key_projects.rst Outdated
Comment thread source/key_projects.rst Outdated
Comment thread source/key_projects.rst Outdated
@bhrutledge
Copy link
Copy Markdown
Contributor

Also, thanks for putting the time into this, and the attention to detail. I think it’s a nice improvement.

Comment thread source/key_projects.rst Outdated
Comment thread source/key_projects.rst Outdated
brainwane and others added 9 commits February 3, 2020 07:37
Co-Authored-By: Brian Rutledge <brian@bhrutledge.com>
Co-Authored-By: Brian Rutledge <brian@bhrutledge.com>
Co-Authored-By: Brian Rutledge <brian@bhrutledge.com>
Co-Authored-By: Brian Rutledge <brian@bhrutledge.com>
Co-Authored-By: Brian Rutledge <brian@bhrutledge.com>
Co-Authored-By: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
Thanks to @webknjaz for the suggestion.
@brainwane brainwane requested a review from uranusjr February 3, 2020 13:28
@brainwane
Copy link
Copy Markdown
Contributor Author

Added several projects and improved wording and detail for several existing projects.

Comment thread source/key_projects.rst Outdated
Comment thread source/key_projects.rst Outdated
Comment thread source/key_projects.rst Outdated
Comment thread source/key_projects.rst
@uranusjr
Copy link
Copy Markdown
Member

uranusjr commented Feb 3, 2020

I’m on my phone right now; there are several casing and format inconsistencies that could use some fixing. I see at least three different renderings for distlib alone: Distlib, distlib, and distlib.

Co-Authored-By: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
Thanks to pradyunsg for suggestion.
@brainwane
Copy link
Copy Markdown
Contributor Author

I've fixed up a few formatting inconsistencies (addressing @uranusjr's comments) as best I could given the inconsistency of the formatting beforehand. Also I've now added web links to the IRC channels.

I believe this is ready to merge and would substantially improve the Key Projects page when merged, with better basic overviews of many important packaging projects. I respect that this PR is a chance to fix a bunch of formatting and wording stuff in a piece of documentation that hasn't gotten a ton of love lately. May I ask that we try to merge this is, and make follow-up PRs or issues about further improving casing/formatting consistency, advising users in more detail about gotchas, and so on?

@ncoghlan ncoghlan merged commit 170d7b9 into pypa:master Feb 3, 2020
@brainwane brainwane deleted the key-projects-update branch April 10, 2020 19:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants