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.

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

[docs] Example: should be Examples: in docstrings #54

Open
mmacy opened this issue Feb 14, 2024 · 0 comments
Open

[docs] Example: should be Examples: in docstrings #54

mmacy opened this issue Feb 14, 2024 · 0 comments
Assignees
@mmacy
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@mmacy
Copy link
Collaborator

mmacy commented Feb 14, 2024

The second form, Examples:, is recognized as a valid docstring section while the former is not.

Needs a global search-and-replace.
@mmacy mmacy added bug Something isn't working documentation Improvements or additions to documentation labels Feb 14, 2024
@mmacy mmacy self-assigned this Feb 14, 2024
@mmacy mmacy changed the title Example: should be Examples: in docstrings [docs] Example: should be Examples: in docstrings Aug 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mmacy mmacy

Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@mmacy