Skip to content

gh-108202: Document calendar.Calendar.firstweekday #128566

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 4 commits into from
Jan 7, 2025
Merged

gh-108202: Document calendar.Calendar.firstweekday #128566

merged 4 commits into from
Jan 7, 2025

Conversation

erlend-aasland
Copy link
Contributor

@erlend-aasland erlend-aasland commented Jan 6, 2025 •
edited
Loading

Follow-up to #127579. I think we should promote the more pythonic property API, rather than the setter/getter pair.

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

@erlend-aasland erlend-aasland added skip news needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels Jan 6, 2025
@bedevere-app bedevere-app bot added the docs Documentation in the Doc dir label Jan 6, 2025
@bedevere-app bedevere-app bot mentioned this pull request Jan 6, 2025
Open
eendebakpt
eendebakpt approved these changes Jan 7, 2025
View reviewed changes
Copy link
Contributor

@eendebakpt eendebakpt left a comment

Choose a reason for hiding this comment

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

Looks good to me. Either 0-6 or 0--6 would be fine with me, but to be consistent: there is one more 0-6 in the file (for IllegalWeekdayError)

@erlend-aasland
Copy link
Contributor Author

I noticed, but double dash is used for many other ranges in this file. Amending all of those can be left for another PR.

ZeroIntensity
ZeroIntensity reviewed Jan 7, 2025
View reviewed changes
Doc/library/calendar.rst

This property can also be set and read using
:meth:`~Calendar.setfirstweekday` and
:meth:`~Calendar.getfirstweekday` respectively.
Copy link
Member

Choose a reason for hiding this comment

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

It might be worth recommending usage of either the attribute or the methods, per the zen:

There should be one-- and preferably only one --obvious way to do it.

If you want though, I'm fine to leave it as is. I'm just being nitpicky :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I considered that, but I think the zen train already left the calendar module API :) IMO, a better approach would be to soft deprecate the set/get method pair.

@erlend-aasland erlend-aasland merged commit b3cbd8f into python:main Jan 7, 2025
29 checks passed
@erlend-aasland erlend-aasland deleted the docs/calendar-firstweekday-attr branch January 7, 2025 07:59
@miss-islington-app
Copy link

Thanks @erlend-aasland for the PR 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 7, 2025
@erlend-aasland @miss-islington
pythongh-108202: Document calendar.Calendar.firstweekday (pythonGH-12…
37e7960 
…8566)

(cherry picked from commit b3cbd8f)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
@erlend-aasland
Copy link
Contributor Author

Thanks for the reviews, everyone!

@bedevere-app
Copy link

bedevere-app bot commented Jan 7, 2025

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 7, 2025
@erlend-aasland @miss-islington
pythongh-108202: Document calendar.Calendar.firstweekday (pythonGH-12…
1ee6be8 
…8566)

(cherry picked from commit b3cbd8f)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Jan 7, 2025
@bedevere-app
Copy link

bedevere-app bot commented Jan 7, 2025

GH-128580 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 Jan 7, 2025
erlend-aasland added a commit that referenced this pull request Jan 7, 2025
@miss-islington @erlend-aasland
[3.13] gh-108202: Document calendar.Calendar.firstweekday (GH-128566) (…
8f3e555 
…#128579)

(cherry picked from commit b3cbd8f)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
erlend-aasland added a commit that referenced this pull request Jan 7, 2025
@miss-islington @erlend-aasland
[3.12] gh-108202: Document calendar.Calendar.firstweekday (GH-128566) (…
adddbc3 
…#128580)

(cherry picked from commit b3cbd8f)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
srinivasreddy pushed a commit to srinivasreddy/cpython that referenced this pull request Jan 8, 2025
@erlend-aasland @srinivasreddy
pythongh-108202: Document calendar.Calendar.firstweekday (python#128566)
43f0411
@StanFromIreland StanFromIreland mentioned this pull request Feb 2, 2025
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ZeroIntensity ZeroIntensity ZeroIntensity left review comments

@eendebakpt eendebakpt eendebakpt approved these changes

@hugovk hugovk hugovk approved these changes

Assignees
No one assigned
Labels
docs Documentation in the Doc dir skip news
Projects
Docs PRs
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@erlend-aasland @eendebakpt @hugovk @ZeroIntensity