MAINT Fix lint, clean and expand docstrings #1169
Merged
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
for more information, see https://pre-commit.ci
larsoner
approved these changes
Aug 17, 2023
There was a problem hiding this comment.
Awesome @lucyleeow , I was not happy adding all those ignores -- it'll be nice to have them gone!
larsoner
reviewed
Aug 17, 2023
sphinx_gallery/scrapers.py
Outdated
| 0: /home/sample-proj/source/plot_types/images/img1.png, | ||
| 2.0: /home/sample-proj/source/plot_types/images/img1_2_00x.png, | ||
| The result will be: | ||
|
|
||
| The result wwould be: |
There was a problem hiding this comment.
Suggested change
| The result wwould be: | |
| The result would be: |
Also there are spelling failures in CIs
larsoner
reviewed
Aug 17, 2023
for more information, see https://pre-commit.ci
lucyleeow
commented
Aug 18, 2023
| Regex to find references to python objects. | ||
| example_globals: Optional[Dict[str, Any]] | ||
| Global variables for examples. Default=None | ||
| node : ast.Module or str |
There was a problem hiding this comment.
When using default 'exec' I think the output is ast.Module:
https://greentreesnakes.readthedocs.io/en/latest/tofrom.html#getting-to-and-from-asts
|
Thanks! I did not expect CIs to be green already! |
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.
Addresses some docstring lint rules previously ignored.
Turned out to be larger than I initially expected. If you're wanting to take a look @larsoner, would be useful to just look at any 'parameter' additions to make sure they are correct.