Skip to content

DOC: Document default cap styles#22053

Merged
timhoffm merged 1 commit into
matplotlib:mainfrom
StefRe:fix/issue21979
Jan 11, 2022
Merged

DOC: Document default cap styles#22053
timhoffm merged 1 commit into
matplotlib:mainfrom
StefRe:fix/issue21979

Conversation

@StefRe

@StefRe StefRe commented Dec 27, 2021

Copy link
Copy Markdown
Contributor

PR Summary

  • remove '(default)' from cap style demo as this is only true for Line2D
    and the default rcParameters
  • document default cap styles for Line2D and Patch in their cap style
    setters
  • document default cap style for GraphicsContextBase in the same way as
    it's already done for joinstyle

Closes #21979. If this goes in I can do the same for join styles, see #18597 (just documenting the current state).

PR Checklist

Tests and Styling

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

Documentation

  • [N/A] New features are documented, with examples if plot related.
  • [N/A] New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • [N/A] API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).

@StefRe

StefRe commented Dec 27, 2021

Copy link
Copy Markdown
Contributor Author

Hm, I don't quite understand why test coverage failed (coverage decreased by 0.06 %) when I delete one line of code
in a function that is not covered by any tests. Coverage should increase in such a case, shouldn't it?

timhoffm
timhoffm reviewed Jan 11, 2022
View reviewed changes
Comment thread lib/matplotlib/lines.py Outdated
Comment thread lib/matplotlib/lines.py Outdated
Comment thread lib/matplotlib/patches.py Outdated
@StefRe

StefRe commented Jan 11, 2022

Copy link
Copy Markdown
Contributor Author

Hm, CircleCI failed with

fatal: remote error:
The unauthenticated git protocol on port 9418 is no longer supported.
Please see https://github.blog/2021-09-01-improving-git-protocol-security-github/ for more information.

I guess this is unrelated to the PR.

@StefRe StefRe requested a review from timhoffm January 11, 2022 10:40
@timhoffm

timhoffm commented Jan 11, 2022

Copy link
Copy Markdown
Member

The error is fixed in #22190. Please rebase on main so that we are sure there are no other issues in the doc build.

timhoffm
timhoffm reviewed Jan 11, 2022
View reviewed changes
Comment thread lib/matplotlib/lines.py
Comment thread lib/matplotlib/lines.py
Comment thread lib/matplotlib/patches.py
@StefRe
DOC: Document default cap styles
b24acb7 
- remove '(default)' from cap style demo as this is only true for Line2D
  and the default rcParameters
- document default cap styles for Line2D and Patch in their cap style
  setters
- document default cap style for GraphicsContextBase in the same way as
  it's already done for joinstyle
@StefRe

StefRe commented Jan 11, 2022

Copy link
Copy Markdown
Contributor Author

The error is fixed in #22190. Please rebase on main so that we are sure there are no other issues in the doc build.

Sorry, didn't see that. Rebased and completed the suggested changes.

@StefRe StefRe requested a review from timhoffm January 11, 2022 15:44
@timhoffm timhoffm added this to the v3.5.2 milestone Jan 11, 2022
@timhoffm timhoffm merged commit eaadeb6 into matplotlib:main Jan 11, 2022
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Jan 11, 2022
@timhoffm @meeseeksmachine
Backport PR matplotlib#22053: DOC: Document default cap styles
ae7f973
@meeseeksmachine meeseeksmachine mentioned this pull request Jan 11, 2022
Merged
@StefRe StefRe deleted the fix/issue21979 branch January 11, 2022 18:58
timhoffm added a commit that referenced this pull request Jan 11, 2022
@timhoffm
Merge pull request #22201 from meeseeksmachine/auto-backport-of-pr-22…
50ea2e5 
…053-on-v3.5.x

Backport PR #22053 on branch v3.5.x (DOC: Document default cap styles)
@StefRe StefRe mentioned this pull request Jan 12, 2022
Merged
2 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

Documentation

Projects

None yet

Milestone

v3.5.2

Development

Successfully merging this pull request may close these issues.

[Doc]: Clarify default capstyle

2 participants

@StefRe @timhoffm