Change PR06 logic to only fail when type is used standalone #447
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rossbar
reviewed
Jan 23, 2023
As per feedback in numpy#447
|
The CI failures are unrelated - see pydata/pydata-sphinx-theme#1130. |
|
I'm going to go ahead and get this in since CI has been patched. Thanks for raising+fixing @amoeba |
|
Thank you @rossbar! |
guillaumedavidphd
added a commit
to guillaumedavidphd/numpydoc
that referenced
this pull request
Apr 7, 2023
* MAINT: Fix CIs for sphinx 6 (numpy#448) * BUG: PR06 logic to only fail when type is used standalone (numpy#447) Change PR06 logic to only fail when type is used standalone. This prevents failures for user-defined classes, e.g. Mystring Co-authored-by: Ross Barnowski <rossbar@berkeley.edu> * Update pre-commit (numpy#449) * Update pre-commit * Run pre-commit on all files * Update blacken-docs repo in pre-commit conf after owner transfer. (numpy#451) * MAINT: Compatibility with pydata-sphinx-theme (numpy#453) Fix compatibility issues between latest pydata-sphinx-theme and sphinx 6. Increase granularity of CI to test across necessary sphinx & Python version combos. * MAINT: Refactoring `get_doc_object` (numpy#452) --------- Co-authored-by: Eric Larson <larson.eric.d@gmail.com> Co-authored-by: Bryce Mecum <petridish@gmail.com> Co-authored-by: Ross Barnowski <rossbar@berkeley.edu> Co-authored-by: Jarrod Millman <jarrod.millman@gmail.com> Co-authored-by: Stefanie Molin <24376333+stefmolin@users.noreply.github.com> Co-authored-by: yuki <126044367+F3eQnxN3RriK@users.noreply.github.com>
guillaumedavidphd
added a commit
to guillaumedavidphd/numpydoc
that referenced
this pull request
Apr 18, 2023
* MAINT: Fix CIs for sphinx 6 (numpy#448) * BUG: PR06 logic to only fail when type is used standalone (numpy#447) Change PR06 logic to only fail when type is used standalone. This prevents failures for user-defined classes, e.g. Mystring Co-authored-by: Ross Barnowski <rossbar@berkeley.edu> * Update pre-commit (numpy#449) * Update pre-commit * Run pre-commit on all files * Update blacken-docs repo in pre-commit conf after owner transfer. (numpy#451) * MAINT: Compatibility with pydata-sphinx-theme (numpy#453) Fix compatibility issues between latest pydata-sphinx-theme and sphinx 6. Increase granularity of CI to test across necessary sphinx & Python version combos. * MAINT: Refactoring `get_doc_object` (numpy#452) --------- Co-authored-by: Eric Larson <larson.eric.d@gmail.com> Co-authored-by: Bryce Mecum <petridish@gmail.com> Co-authored-by: Ross Barnowski <rossbar@berkeley.edu> Co-authored-by: Jarrod Millman <jarrod.millman@gmail.com> Co-authored-by: Stefanie Molin <24376333+stefmolin@users.noreply.github.com> Co-authored-by: yuki <126044367+F3eQnxN3RriK@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #446
This is a draft PR for addressing #446 which hasn't yet been discussed. For reviewing, I'd pay special attention to how I went the logic in
validate.py, especially the regex.