Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Fix doc-string issues identified by velin #25327

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
Merged
merged 1 commit into from
Feb 26, 2023
Merged

Fix doc-string issues identified by velin #25327

merged 1 commit into from
Feb 26, 2023

Conversation

oscargus
Copy link
Member

PR Summary

Trying out velin and these are fixes for some of the identified issues
(not including incorrect indentation etc).

(Some are identified when searching for the location of the actual issue...)

PR Checklist

Documentation and Tests

  • Has pytest style unit tests (and pytest passes)
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • New plotting related features are documented with examples.

Release Notes

  • New features are marked with a .. versionadded:: directive in the docstring and documented in doc/users/next_whats_new/
  • API changes are marked with a .. versionchanged:: directive in the docstring and documented in doc/api/next_api_changes/
  • Release notes conform with instructions in next_whats_new/README.rst or next_api_changes/README.rst

@oscargus oscargus added this to the v3.7.1 milestone Feb 25, 2023
@oscargus oscargus changed the title Fix doc issues identified by velin Fix doc-string issues identified by velin Feb 25, 2023
@timhoffm timhoffm merged commit 80a6868 into matplotlib:main Feb 26, 2023
@lumberbot-app
Copy link

lumberbot-app bot commented Feb 26, 2023

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 v3.7.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 80a68682484095c9d72b8ad591bbc03ffef12b45
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
git commit -am 'Backport PR #25327: Fix doc-string issues identified by velin'
  1. Push to a named branch:
git push YOURFORK v3.7.x:auto-backport-of-pr-25327-on-v3.7.x
  1. Create a PR against branch v3.7.x, I would have named this PR:

"Backport PR #25327 on branch v3.7.x (Fix doc-string issues identified by velin)"

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.

oscargus pushed a commit to oscargus/matplotlib that referenced this pull request Feb 26, 2023
@timhoffm @oscargus
Backport PR matplotlib#25327: Fix doc-string issues identified by velin
b6a779e
@oscargus oscargus deleted the docfixesvelin branch February 26, 2023 10:54
greglucas added a commit that referenced this pull request Feb 26, 2023
@greglucas
Merge pull request #25331 from oscargus/auto-backport-of-pr-25327-on-…
ef56b32 
…v3.7.x

Backport PR #25327 on branch v3.7.x (Fix doc-string issues identified by velin)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@timhoffm timhoffm timhoffm approved these changes

Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
v3.7.1
Development

Successfully merging this pull request may close these issues.
2 participants
@oscargus @timhoffm