Skip to content

gh-123445: calendar: Improve descriptions for day and month attributes #123483

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 9 commits into from
Sep 25, 2024
Merged

gh-123445: calendar: Improve descriptions for day and month attributes #123483

merged 9 commits into from
Sep 25, 2024

Conversation

m4t5
Copy link
Contributor

@m4t5 m4t5 commented Aug 29, 2024 •
edited by github-actions bot
Loading

For day_name, day_abbr, month_name and month_abbr, change return type from "array" to "sequence".

📚 Documentation preview 📚: https://cpython-previews--123483.org.readthedocs.build/

@ghost
Copy link

ghost commented Aug 29, 2024 •
edited by ghost
Loading

All commit authors signed the Contributor License Agreement.
CLA signed

@bedevere-app bedevere-app bot mentioned this pull request Aug 29, 2024
Closed
@bedevere-app bedevere-app bot added docs Documentation in the Doc dir skip news awaiting review labels Aug 29, 2024
@hugovk hugovk added needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels Aug 30, 2024
@hugovk
Copy link
Member

hugovk commented Aug 30, 2024

Thanks, the OP at #123445 suggested:

Also, it would be helpful to provide documentation with regards to how to use the object returned to obtain the day names.

Would you like to add one?

And please could you give the PR a more descriptive title?

@m4t5 m4t5 changed the title gh-123445: Update Doc/library/calendar.rst gh-123445: Update Doc/library/calendar.rst to improve day_name, day_abbr, month_name and month_abbr Aug 30, 2024
@m4t5 m4t5 requested a review from rhettinger as a code owner August 30, 2024 22:07
@m4t5
Copy link
Contributor Author

m4t5 commented Aug 30, 2024

How's that?

I see the lint failed - do I need to recommit without trailing whitespace? I also don't understand why Tests / Docs / Docs (pull_request) failed. Any pointers appreciated.

@rhettinger rhettinger removed their request for review August 31, 2024 01:49
@AA-Turner
Copy link
Member

@m4t5 I've pushed a commit to remove whitespace to fix the tests, and also to reduce the wording change and restore the documentation for the module level enums. We also remove an accidentally committed file.

In terms of the wording for day_name etc, perhaps it would be simpler to say that the sequence uses the convention where the week begins on Monday? Otherwise I think you should specify that you mean 0 / 6 are list indicies or etc.

A

ericvsmith
ericvsmith reviewed Sep 1, 2024
View reviewed changes
Copy link
Member

@ericvsmith ericvsmith left a comment

Choose a reason for hiding this comment

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

Small wording changes.

hugovk
hugovk reviewed Sep 5, 2024
View reviewed changes
ericvsmith and others added 2 commits September 24, 2024 17:16
@ericvsmith @hugovk
Apply suggestions from code review
e29f5fe 
These look good to me.

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
@AA-Turner @hugovk
Apply suggestions from code review
983c6a9 
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
@AA-Turner AA-Turner changed the title gh-123445: Update Doc/library/calendar.rst to improve day_name, day_abbr, month_name and month_abbr gh-123445: calendar: Improve descriptions for day and month attributes Sep 25, 2024
@AA-Turner AA-Turner merged commit 8447c93 into python:main Sep 25, 2024
23 checks passed
@miss-islington-app
Copy link

Thanks @m4t5 for the PR, and @AA-Turner for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Sep 25, 2024
@m4t5 @AA-Turner
@ericvsmith @hugovk @miss-islington
pythongh-123445: calendar: Improve descriptions for day and month att…
8ece424 
…ributes (pythonGH-123483)

(cherry picked from commit 8447c93)

Co-authored-by: Mat S <mscull@gmail.com>
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
Co-authored-by: Eric V. Smith <ericvsmith@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
@bedevere-app
Copy link

bedevere-app bot commented Sep 25, 2024

GH-124500 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Sep 25, 2024
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Sep 25, 2024
@m4t5 @AA-Turner
@ericvsmith @hugovk @miss-islington
pythongh-123445: calendar: Improve descriptions for day and month att…
878d150 
…ributes (pythonGH-123483)

(cherry picked from commit 8447c93)

Co-authored-by: Mat S <mscull@gmail.com>
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
Co-authored-by: Eric V. Smith <ericvsmith@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
@bedevere-app
Copy link

bedevere-app bot commented Sep 25, 2024

GH-124501 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.12 only security fixes label Sep 25, 2024
AA-Turner added a commit that referenced this pull request Sep 25, 2024
@miss-islington @m4t5
@AA-Turner @ericvsmith @hugovk
[3.12] gh-123445: calendar: Improve descriptions for day and month at…
cf06f59 
…tributes (GH-123483) (#124501)

gh-123445: calendar: Improve descriptions for day and month attributes (GH-123483)
(cherry picked from commit 8447c93)

Co-authored-by: Mat S <mscull@gmail.com>
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
Co-authored-by: Eric V. Smith <ericvsmith@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Yhg1s pushed a commit that referenced this pull request Sep 26, 2024
@miss-islington @m4t5
@AA-Turner @ericvsmith @hugovk
[3.13] gh-123445: calendar: Improve descriptions for day and month at…
139f47f 
…tributes (GH-123483) (#124500)

gh-123445: calendar: Improve descriptions for day and month attributes (GH-123483)
(cherry picked from commit 8447c93)

Co-authored-by: Mat S <mscull@gmail.com>
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
Co-authored-by: Eric V. Smith <ericvsmith@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ericvsmith ericvsmith ericvsmith left review comments

@hugovk hugovk hugovk left review comments

Assignees
No one assigned
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@m4t5 @hugovk @AA-Turner @ericvsmith