Skip to content

CI: if no docstring, create error GL08 and don't validate - fix for numpydoc 1.9 #61744

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

Merged
merged 2 commits into from
Jun 30, 2025

Conversation

Dr-Irv
Copy link
Contributor

@Dr-Irv Dr-Irv commented Jun 30, 2025

validate_docstrings was failing with numpydoc 1.9 on cython methods that have no docstrings. When no docstring, there is nothing to validate.

Partially addresses the CI issue mentioned in #61740

@simonjayhawkins simonjayhawkins added the CI Continuous Integration label Jun 30, 2025
@jbrockmendel
Copy link
Member

is this an alternative to #61725?

@Dr-Irv
Copy link
Contributor Author

Dr-Irv commented Jun 30, 2025

is this an alternative to #61725?

Yes, and it allows us to use numpydoc 1.9

@mroeschke mroeschke added the Code Style Code style, linting, code_checks label Jun 30, 2025
@mroeschke mroeschke added this to the 2.3.1 milestone Jun 30, 2025
@mroeschke mroeschke merged commit 30a2e7f into pandas-dev:main Jun 30, 2025
51 of 52 checks passed
@mroeschke
Copy link
Member

Thanks @Dr-Irv

Copy link

lumberbot-app bot commented Jun 30, 2025

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

  1. Checkout backport branch and update it.
git checkout 2.3.x
git pull
  1. Cherry pick the first parent branch of the this PR on top of the older branch:
git cherry-pick -x -m1 30a2e7fb239e63beab44c7c459517eb4d2908a0d
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
git commit -am "Backport PR #61744: CI: if no docstring, create error GL08 and don't validate - fix for numpydoc 1.9"
  1. Push to a named branch:
git push YOURFORK 2.3.x:auto-backport-of-pr-61744-on-2.3.x
  1. Create a PR against branch 2.3.x, I would have named this PR:

"Backport PR #61744 on branch 2.3.x (CI: if no docstring, create error GL08 and don't validate - fix for numpydoc 1.9)"

And apply the correct labels and milestones.

Congratulations — you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon!

Remember to remove the Still Needs Manual Backport label once the PR gets merged.

If these instructions are inaccurate, feel free to suggest an improvement.

@mroeschke mroeschke mentioned this pull request Jun 30, 2025
5 tasks
Dr-Irv added a commit to Dr-Irv/pandas that referenced this pull request Jun 30, 2025
…umpydoc 1.9 (pandas-dev#61744)

* if no docstring, create error GL08 and don't validate

* add file and file_line as None if no docstring

(cherry picked from commit 30a2e7f)
@jorisvandenbossche
Copy link
Member

Backport -> #61745

jorisvandenbossche pushed a commit that referenced this pull request Jul 1, 2025
… GL08 and don't validate - fix for numpydoc 1.9) (#61745)

CI: if no docstring, create error GL08 and don't validate - fix for numpydoc 1.9 (#61744)

* if no docstring, create error GL08 and don't validate

* add file and file_line as None if no docstring

(cherry picked from commit 30a2e7f)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI Continuous Integration Code Style Code style, linting, code_checks
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants