Skip to content

bpo-27752: improve documentation of csv.Dialect#26795

Merged
ambv merged 14 commits into
python:mainfrom
jdevries3133:bpo-27752-csv-docs
Aug 6, 2021
Merged

bpo-27752: improve documentation of csv.Dialect#26795
ambv merged 14 commits into
python:mainfrom
jdevries3133:bpo-27752-csv-docs

Conversation

@jdevries3133

@jdevries3133 jdevries3133 commented Jun 18, 2021 •
edited by bedevere-bot
Loading

Copy link
Copy Markdown
Contributor

Note that all content changes are in the first commit. The second commit is 100% formatting of the rst file. There are also some very minor proofreading corrections in the final commit.

I'm very open to feedback on this; please let me know if there are any bits in here that you feel could be communicated better!

https://bugs.python.org/issue27752

@bedevere-bot bedevere-bot added awaiting review docs Documentation in the Doc dir labels Jun 18, 2021
@iritkatriel

iritkatriel commented Jun 27, 2021

Copy link
Copy Markdown
Member

Note that all content changes are in the first commit. The second commit is 100% formatting of the rst file. There are also some very minor proofreading corrections in the final commit.

The formatting (whitespace?) changes are unlikely to be approved. You should limit this PR to the content change you are making (possibly fix typos in other places).

The PR will be squashed into one commit, so the diff will be huge and hide the actual change. Sweeping whitespace-type changes are not going to be accepted in a separate PR either because they spam the commit log and the "blame" outputs.

@jdevries3133

jdevries3133 commented Jun 28, 2021

Copy link
Copy Markdown
Contributor Author

@iritkatriel Ok, those changes have been reverted.

@github-actions

github-actions Bot commented Jul 29, 2021

Copy link
Copy Markdown

This PR is stale because it has been open for 30 days with no activity.

@github-actions github-actions Bot added the stale Stale PR or inactive for long period of time. label Jul 29, 2021
jdevries3133
jdevries3133 commented Jul 29, 2021
View reviewed changes

@jdevries3133 jdevries3133 left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Don't mind me; just talking to myself. When this was marked stale,I opened it up and saw these issues. I will fix them soon, but don't want anyone to waste their time reviewing in the interim.

Comment thread Doc/library/csv.rst Outdated
Comment thread Doc/library/csv.rst Outdated
Comment thread Doc/library/csv.rst Outdated
Comment thread Doc/library/csv.rst
@iritkatriel

iritkatriel commented Jul 29, 2021

Copy link
Copy Markdown
Member

Don't mind me; just talking to myself. When this was marked stale,I opened it up and saw these issues. I will fix them soon, but don't want anyone to waste their time reviewing in the interim.

You can mark the PR as draft and then people won't review it until you say it's ready.

@github-actions github-actions Bot removed the stale Stale PR or inactive for long period of time. label Jul 30, 2021
@jdevries3133

jdevries3133 commented Jul 31, 2021

Copy link
Copy Markdown
Contributor Author

You can mark the PR as draft and then people won't review it until you say it's ready.

@iritkatriel Yes, well the other factor here is that I was reading the diff just before bed and wanted to leave myself the notes as breadcrumbs, too!

Anyway, this PR is ready for another review, I think it is ready to go. The diff is much smaller as I got rid of all whitespace changes, plus a lot of pedantic changes that I can now see were unnecessary. A summary of the changes now are:

  • fix mechanics in two places: change "the dialect" to "dialects" when speaking about dialect classes, in general
  • revise and expand the paragraph of documentation for the Dialect class to make it more descriptive and less technical-jargon dense
  • create hyperlink by changing change "dialect" to "class:Dialect" where appropriate

ambv
ambv approved these changes Aug 2, 2021
View reviewed changes
Comment thread Doc/library/csv.rst Outdated
Comment thread Doc/library/csv.rst Outdated
jdevries3133 and others added 2 commits August 2, 2021 14:11
@jdevries3133 @ambv
capitalize csv
3701f35 
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
@jdevries3133 @ambv
capitalize csv
a77b284 
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
@ambv
ambv merged commit 0ffdced into python:main Aug 6, 2021
@miss-islington

miss-islington commented Aug 6, 2021

Copy link
Copy Markdown
Contributor

Thanks @jdevries3133 for the PR, and @ambv for merging it 🌮🎉.. I'm working now to backport this PR to: 3.9, 3.10.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

@bedevere-bot

bedevere-bot commented Aug 6, 2021

Copy link
Copy Markdown

GH-27643 is a backport of this pull request to the 3.10 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 6, 2021
@jdevries3133 @miss-islington
bpo-27752: improve documentation of csv.Dialect (pythonGH-26795)
a879188 
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit 0ffdced)

Co-authored-by: Jack DeVries <58614260+jdevries3133@users.noreply.github.com>
@bedevere-bot

bedevere-bot commented Aug 6, 2021

Copy link
Copy Markdown

GH-27644 is a backport of this pull request to the 3.9 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 6, 2021
@jdevries3133 @miss-islington
bpo-27752: improve documentation of csv.Dialect (pythonGH-26795)
170ead3 
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit 0ffdced)

Co-authored-by: Jack DeVries <58614260+jdevries3133@users.noreply.github.com>
miss-islington added a commit that referenced this pull request Aug 6, 2021
@miss-islington @jdevries3133
bpo-27752: improve documentation of csv.Dialect (GH-26795)
2fd1f21 
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit 0ffdced)

Co-authored-by: Jack DeVries <58614260+jdevries3133@users.noreply.github.com>
ambv pushed a commit that referenced this pull request Aug 6, 2021
@miss-islington @jdevries3133
bpo-27752: improve documentation of csv.Dialect (GH-26795) (GH-27644)
62bce24 
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit 0ffdced)

Co-authored-by: Jack DeVries <58614260+jdevries3133@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ambv ambv ambv approved these changes

Assignees

No one assigned

Labels

docs Documentation in the Doc dir

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@jdevries3133 @iritkatriel @miss-islington @bedevere-bot @ambv @the-knights-who-say-ni