Skip to content
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.

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

TimezoneTransition is missing from the API documentation #823

Closed
tobinus opened this issue Dec 29, 2021 · 0 comments
Closed

TimezoneTransition is missing from the API documentation #823

tobinus opened this issue Dec 29, 2021 · 0 comments
Assignees

Comments

@tobinus
Copy link

tobinus commented Dec 29, 2021

Overview Description

The TimezoneTransition class in babel.dates is mentioned in the API description of get_next_timezone_transition, but it is never said anywhere what attributes this class has.

The get_next_timezone_transition could specify its return type in its doc text with a reStructuredText markup (instead of only mentioning this in the description), and the TimezoneTransition class should be included in the docs/api/dates.rst document.

Steps to Reproduce

  1. Navigate to http://babel.pocoo.org/en/latest/api/dates.html#babel.dates.get_next_timezone_transition
  2. Try looking for a description of what properties TimezoneTransition has

Actual Results

The properties of TimezoneTransition are not described anywhere in the generated HTML documentation.

Expected Results

The properties of TimezoneTransition are described right next to get_next_timezone_transition.

@tobinus tobinus changed the title TimezoneTransition should be added to the API documentation TimezoneTransition is missing from the API documentation Dec 29, 2021
@akx akx self-assigned this Jan 25, 2022
@akx akx closed this as completed in 0531bc9 Jan 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants