Skip to content

Minor improvements to LogLocator docstring #24435

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
timhoffm merged 1 commit into from
Nov 12, 2022
Merged

Minor improvements to LogLocator docstring #24435

timhoffm merged 1 commit into from
Nov 12, 2022

Conversation

@dstansby
Copy link
Member

@dstansby dstansby commented Nov 12, 2022

PR Summary

  • Make formula in the first line consistent with symbols used in the parameter docs
  • Add allowed strings to type documentation of 'subs'
  • Minor language improvements

PR Checklist

Tests and Styling

  • Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (install flake8-docstrings and run flake8 --docstring-convention=all).

Documentation

  • 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

@timhoffm timhoffm added this to the v3.6.3 milestone Nov 12, 2022
@timhoffm timhoffm merged commit b2c4964 into matplotlib:main Nov 12, 2022
@meeseeksmachine meeseeksmachine mentioned this pull request Nov 12, 2022
Merged
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Nov 12, 2022
@timhoffm @meeseeksmachine
Backport PR matplotlib#24435: Minor improvements to LogLocator docstring
b9058ff
@dstansby dstansby deleted the ll-docstring branch November 12, 2022 15:51
timhoffm added a commit that referenced this pull request Nov 12, 2022
@timhoffm
Merge pull request #24438 from meeseeksmachine/auto-backport-of-pr-24…
ead3d4f 
…435-on-v3.6.x

Backport PR #24435 on branch v3.6.x (Minor improvements to LogLocator docstring)
@ksunden ksunden mentioned this pull request Feb 20, 2023
Merged
6 tasks
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

None yet

Projects

None yet

Milestone

v3.6.3

Development

Successfully merging this pull request may close these issues.

2 participants

@dstansby @timhoffm