Add documentation regarding transparency of frame #18658
Conversation
follow up to issue #18257
Originally posted by @jklymak in #18257 (comment) @jklymak sorry it did take me quite a while |
| frameon : bool, default: True | ||
| If True, draw a box around this artists. | ||
| If True, add a frame and solid background for the artist. The frame's appearance can be changed with the `facecolor` and `edgecolor` kwargs. |
There was a problem hiding this comment.
Use 'keyword arguments' instead of 'kwargs'; this needs to be line-wrapped as well. Also, parameter names should be surrounded by *, not `.
There was a problem hiding this comment.
It still needs to be word-wrapped at under 80 characters.
There was a problem hiding this comment.
new line added and seems to fixed the max 80 char issue
QuLogic
changed the title
abide 80-chars max linter rules
|
Still a flake8 issue: |
didn't realize it. Thanks for pointing out. |
Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com>
| Frame appearance can be changed with, i.e. | ||
| *facecolor* and *edgecolor* keyword arguments. | ||
| If False, possibly allow image with proper transparency. |
There was a problem hiding this comment.
I don't understand this sentence:
- What does "possibly" mean here?
- What is the "image"?
QuLogic
added
the
status: needs clarification
|
@grrlic are you planning to finish this? Thanks! |
thanks for getting back! but not sure why the commit still failed :" |
|
You need t rebase on master and resolve any conflicts. This is described (somewhat enigmatically in my opinion) at https://matplotlib.org/stable/devel/gitwash/development_workflow.html#rebasing-on-trunk - just skip to the |
5 participants
follow up to issue #18257
PR Summary
PR Checklist
pytestpasses).flake8on changed files to check).flake8-docstringsandpydocstyle<4and runflake8 --docstring-convention=all).doc/users/next_whats_new/(follow instructions in README.rst there).doc/api/next_api_changes/(follow instructions in README.rst there).