Fixed Comments and Clarification #20652
Draft
Conversation
Thank you for your work @engjellavdiu , however I have some concerns I noted above. Any one who has the power to clear my review may do so. |
You are right on all of them |
fixed based on suggestions from @tacaswell
@@ -20,8 +20,8 @@ Below is a brief description of the different directories found here: | |||
|
|||
* axisartist - Examples related to the axisartist toolkit. | |||
|
|||
* event_handling - How to interact with your figure, mouse presses, | |||
key presses, object picking, etc. | |||
* event_handling - How to interact with your figure, mousepresses, |
timhoffm
Jul 17, 2021
Member
I don't think this change is correct. We use the two-word version throughout the docs except for "keypress event", but there "keypress" is a fixed term.
* tests - Tests used by Matplotlib developers to check functionality. | ||
(These tests are still sometimes useful, but mostly developers should | ||
(These tests are still sometimes useful, but most developers should | ||
use the pytest tests which perform automatic image comparison.) |
Comment on lines
33
to
35
jklymak
Jul 21, 2021
Contributor
This whole bullet should just go away as this subdirectory does not exist any longer
This whole file should just be removed, unless I am missing something. README.txt is what gets rendered in the docs. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
PR Summary
PR Checklist
pytest
passes).flake8
on changed files to check).flake8-docstrings
and 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).