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

Dedent section starting with .. deprecation:: #575

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Dedent section starting with .. deprecation:: #575

wants to merge 1 commit into from

Conversation

stefanv
Copy link
Contributor

@stefanv stefanv commented Jul 17, 2024 •
edited
Loading

Closes #573

There may be a more elegant way to fix this. Problem is that section that starts with deprecation warning comes back indented, and therefore fails to meet the test doc.extended_summary.startswith(".. deprecated:: ").

Reproducer:

foo.py:

def my_func_right():
    """Compute my function.

    .. deprecated:: v0.1
        This function is listed for future removal.

    What it does in more detail.
    """
    pass

$ numpydoc lint foo.py

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
type: Bug fix
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Validation rule GL09 failing
1 participant
@stefanv