Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Docstring cleanups around DATA_PARAMETER_PLACEHOLDER.#21140

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
tacaswell merged 1 commit intomatplotlib:masterfromanntzer:dpp
Sep 22, 2021

Conversation

anntzer
Copy link
Contributor

  • [notes section required to get data note injection right] has been
    obsoleted by DATA_PARAMETER_PLACEHOLDER; get rid of them.
  • loglog, semilogx, semilogy are thin wrappers around plot; it seems
    fine to not document data there and leave it implicitly part of
    **kwargs: all parameters supported by plot. Then "Other Parameters"
    only contains**kwargs whose description is quite short, so it can
    just be lifted into the main Parameters section rather than requiring
    a separate section just for itself.
  • Likewise forstep, but that method actually explicitly listsdata
    in its signature, so just move its (already existing) description down
    to its correct position.

This change was motivated by the fact that DATA_PARAMETER_PLACEHOLDER is
not correctly handled for these simple plot() wrappers; because they all
operate without going through _preprocess_data(), fixing them would also
require their own ad-hoc solution anyways. (#21135)

PR Summary

PR Checklist

  • Has pytest style unit tests (andpytest passes).
  • IsFlake 8 compliant (runflake8 on changed files to check).
  • New features are documented, with examples if plot related.
  • Documentation is sphinx and numpydoc compliant (the docs shouldbuild without error).
  • Conforms to Matplotlib style conventions (installflake8-docstrings and runflake8 --docstring-convention=all).
  • New features have an entry indoc/users/next_whats_new/ (follow instructions in README.rst there).
  • API changes documented indoc/api/next_api_changes/ (follow instructions in README.rst there).

- `[notes section required to get data note injection right]` has been  obsoleted by DATA_PARAMETER_PLACEHOLDER; get rid of them.- loglog, semilogx, semilogy are thin wrappers around plot; it seems  fine to not document data there and leave it implicitly part of  `**kwargs: all parameters supported by plot`.  Then "Other Parameters"  only contains `**kwargs` whose description is quite short, so it can  just be lifted into the main Parameters section rather than requiring  a separate section just for itself.- Likewise for `step`, but that method actually explicitly lists `data`  in its signature, so just move its (already existing) description down  to its correct position.This change was motivated by the fact that DATA_PARAMETER_PLACEHOLDER isnot correctly handled for these simple plot() wrappers; because they alloperate without going through _preprocess_data(), fixing them would alsorequire their own ad-hoc solution anyways.
@tacaswelltacaswell added this to thev3.5.0 milestoneSep 22, 2021
@tacaswelltacaswell merged commitbdc4f04 intomatplotlib:masterSep 22, 2021
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull requestSep 22, 2021
@anntzeranntzer deleted the dpp branchSeptember 22, 2021 22:46
QuLogic added a commit that referenced this pull requestSep 23, 2021
…140-on-v3.5.xBackport PR#21140 on branch v3.5.x (Docstring cleanups around DATA_PARAMETER_PLACEHOLDER.)
tacaswell added a commit to tacaswell/matplotlib that referenced this pull requestOct 12, 2021
DOC: Docstring cleanups around DATA_PARAMETER_PLACEHOLDER.
tacaswell added a commit that referenced this pull requestOct 20, 2021
DOC: Docstring cleanups around DATA_PARAMETER_PLACEHOLDER.
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@tacaswelltacaswelltacaswell approved these changes

@jklymakjklymakjklymak approved these changes

Assignees
No one assigned
Projects
None yet
Milestone
v3.5.0
Development

Successfully merging this pull request may close these issues.

3 participants
@anntzer@tacaswell@jklymak

[8]ページ先頭

©2009-2025 Movatter.jp