Activity

1. erlend-aasland

   added

   docsDocumentation in the Doc dirDocumentation in the Doc dir

   on Aug 21, 2023
2. hugovk

   changed the title [-]Docs: the calendar module lacks documentation for several APIS[/-] [+]Docs: the calendar module lacks documentation for several APIs[/+] on Aug 21, 2023
3. AA-Turner commented on Aug 21, 2023

   

   AA-Turner

   on Aug 21, 2023

   Member

   More actions

   (status as at 21c0844)

   Defined in __all__ but not documented

   • IllegalMonthError (GH-108202: Document calendar exceptions #108398)
   • IllegalWeekdayError (GH-108202: Document calendar exceptions #108398)
   • JANUARY, etc (These are documented as Month.X, but also exist in the module scope) (GH-108202: Combine documentation of calendar constants #108492)
   • MONDAY, etc (These are documented as Day.X, but also exist in the module scope) (GH-108202: Combine documentation of calendar constants #108492)

   Undocumented classes

   • different_locale (should not be documented, helper class)

   Undocumented functions

   • prweek()
   • week()
   • format()
   • formatstring()

   Undocumented methods

   Calendar

   • Calendar.getfirstweekday()
   • Calendar.setfirstweekday()
   • Calendar.firstweekday: (gh-108202: Document calendar.Calendar.firstweekday #128566)

   TextCalendar

   • TextCalendar.prweek() (gh-108202: calendar: Document prweek #108466)
   • TextCalendar.formatday() (gh-128317: Document calendar.TextCalendar.formatweek #128353)
   • TextCalendar.formatweek()
   • TextCalendar.formatweekday()
   • TextCalendar.formatweekheader()
   • TextCalendar.formatmonthname()

   HTMLCalendar

   • HTMLCalendar.formatday()
   • HTMLCalendar.formatweek()
   • HTMLCalendar.formatweekday()
   • HTMLCalendar.formatweekheader()
   • HTMLCalendar.formatmonthname()

   Undocumented attributes

   • EPOCH (should not be documented, of no use)
   • mdays (should not be documented, of no use)

   Undocumented miscellany

   • python -m calendar (main()) (GH-108202: Document calendar's command-line interface #109020)

   A

   Reacted by Hugo van Kemenade, Erlend E. Aasland and W. H. Wang
4. AA-Turner commented on Aug 21, 2023

   

   AA-Turner

   on Aug 21, 2023

   Member

   More actions

   I think at the least we ought document IllegalMonthError and IllegalWeekdayError, I'll open a PR shortly.

   A

   Reacted by Erlend E. Aasland
5. miss-islington

   added a commit that references this issue on Aug 25, 2023

   pythonGH-108202: Document ``calendar`` exceptions (pythonGH-108398)

   be32246
6. hugovk

   added a commit that references this issue on Aug 25, 2023

   GH-108202: Document ``calendar`` exceptions (#108398)

   1350987
7. miss-islington

   added a commit that references this issue on Aug 25, 2023

   pythonGH-108202: Document ``calendar`` exceptions (pythonGH-108398)

   3f6fc2a
8. hugovk

   added a commit that references this issue on Aug 25, 2023

   [3.11] GH-108202: Document ``calendar`` exceptions (GH-108398) (#108468)

   ee61f7d
9. Yhg1s

   added a commit that references this issue on Aug 25, 2023

   [3.12] GH-108202: Document ``calendar`` exceptions (GH-108398) (#108467)

   c5448ab
10. hugovk

    added a commit that references this issue on Aug 28, 2023

    GH-108202: Combine documentation of ``calendar`` constants (#108492)

    5d936b6
11. AA-Turner

    added a commit that references this issue on Aug 28, 2023

    [3.12] pythonGH-108202: Combine documentation of ``calendar`` constan…

    a15a3bf
12. Yhg1s

    added a commit that references this issue on Aug 28, 2023

    [3.12] GH-108202: Combine documentation of ``calendar`` constants (GH…

    7c7b2bf
13. hugovk

    added a commit that references this issue on Sep 6, 2023

    GH-108202: Document ``calendar``'s command-line interface (#109020)

    f0f96a9
14. miss-islington

    added 2 commits that reference this issue on Sep 6, 2023

    pythonGH-108202: Document ``calendar``'s command-line interface (pyth…

    df7a06d

    pythonGH-108202: Document ``calendar``'s command-line interface (pyth…

    d958106
15. 14 remaining items
16. erlend-aasland

    added a commit that references this issue on Jan 6, 2025

    gh-108202: Document `calendar.Calendar` methods `getfirstweekday` and…

    953b49e
17. miss-islington

    added 2 commits that reference this issue on Jan 6, 2025

    pythongh-108202: Document `calendar.Calendar` methods `getfirstweekda…

    9e1f1ff

    pythongh-108202: Document `calendar.Calendar` methods `getfirstweekda…

    82f16d1
18. erlend-aasland

    added 4 commits that reference this issue on Jan 6, 2025

    [3.13] gh-108202: Document `calendar.Calendar` methods `getfirstweekd…

    d81b99b

    [3.12] gh-108202: Document `calendar.Calendar` methods `getfirstweekd…

    fb8bb36

    pythongh-108202: Document calendar.Calendar.firstweekday

    8133ed1

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

    b3cbd8f
19. miss-islington

    added 2 commits that reference this issue on Jan 7, 2025

    pythongh-108202: Document calendar.Calendar.firstweekday (pythonGH-12…

    37e7960

    pythongh-108202: Document calendar.Calendar.firstweekday (pythonGH-12…

    1ee6be8
20. erlend-aasland

    added 2 commits that reference this issue on Jan 7, 2025

    [3.13] gh-108202: Document calendar.Calendar.firstweekday (GH-128566) (…

    8f3e555

    [3.12] gh-108202: Document calendar.Calendar.firstweekday (GH-128566) (…

    adddbc3
21. srinivasreddy

    added 3 commits that reference this issue on Jan 8, 2025

    pythongh-108202: Document calendar.TextCalendar formatting helpers (p…

    f529d7f

    pythongh-108202: Document `calendar.Calendar` methods `getfirstweekda…

    1d65bf6

    pythongh-108202: Document calendar.Calendar.firstweekday (python#128566)

    43f0411
22. hugovk

    added a commit that references this issue on Dec 8, 2025

    gh-108202: ``calendar``: Document ``prweek`` (#108466)

    8620d30