Skip to content

Docs: Resolve Sphinx warnings in calendar.rst - #108192

Closed
erlend-aasland wants to merge 2 commits into
python:mainfrom
erlend-aasland:docs/calendar.rst
Closed

Docs: Resolve Sphinx warnings in calendar.rst#108192
erlend-aasland wants to merge 2 commits into
python:mainfrom
erlend-aasland:docs/calendar.rst

Conversation

@erlend-aasland

@erlend-aaslanderlend-aasland commented Aug 21, 2023•
edited
Loading

Copy link
Copy Markdown
Contributor
  • Add docs for HTMLCalendar.formatmonthname
  • Fix links to HTMLCalendar methods
  • Suppress links in HTMLCalendar subclass note

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

@erlend-aasland
Docs: Resolve Sphinx warnings in calendar.rst
ab3cc0f
- Add docs for HTMLCalendar.formatmonthname
- Fix links to HTMLCalendar methods
- Suppress links in HTMLCalendar subclass note
serhiy-storchaka
serhiy-storchaka reviewed Aug 21, 2023
View reviewed changes
Comment threadDoc/library/calendar.rst Outdated
Comment threadDoc/library/calendar.rst Outdated
erlend-aasland
erlend-aasland commented Aug 21, 2023
View reviewed changes
Comment threadDoc/library/calendar.rst Outdated
@erlend-aaslanderlend-aasland mentioned this pull request Aug 21, 2023
Open
serhiy-storchaka
serhiy-storchaka reviewed Aug 21, 2023
View reviewed changes
Comment threadDoc/library/calendar.rst
.. note::

The constructor, :meth:`formatweekday` and :meth:`formatmonthname` methods
The constructor, :meth:`!formatweekday` and :meth:`!formatmonthname` methods

@serhiy-storchakaserhiy-storchakaAug 21, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Ignoring valid warnings will only make us forget about the issue. We already have too many open and forgotten issues.

If the goal is to suppress warnings, just add the corresponding option to Sphinx invocation.

@erlend-aasland

erlend-aasland commented Aug 21, 2023

Copy link
Copy Markdown
ContributorAuthor

It seems to me this PR risks running stale. Instead of contributing to the huge number of stale PRs, I'll close this issue right away. The status quo is not better or worse than this PR (the current links don't work anyway). I created issue gh-108202 for the undocumented methods of the calendar module.

@erlend-aasland
erlend-aasland deleted the docs/calendar.rst branch August 21, 2023 10:47
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@serhiy-storchakaserhiy-storchakaserhiy-storchaka left review comments
@AA-TurnerAA-TurnerAwaiting requested review from AA-TurnerAA-Turner is a code owner

Assignees

No one assigned

Labels

awaiting core reviewneeds backport to 3.11only security fixesneeds backport to 3.12only security fixesskip issueskip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@erlend-aasland@serhiy-storchaka@bedevere-bot