Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed Comments and Clarification #20652

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

@engjellavdiu
Copy link

@engjellavdiu engjellavdiu commented Jul 15, 2021

PR Summary

PR Checklist

  • Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (run flake8 on changed files to check).
  • New features are documented, with examples if plot related.
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • Conforms to Matplotlib style conventions (install flake8-docstrings and run flake8 --docstring-convention=all).
  • New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).
examples/README Outdated Show resolved Hide resolved
examples/README Outdated Show resolved Hide resolved
examples/README Show resolved Hide resolved
@tacaswell tacaswell added this to the v3.5.0 milestone Jul 15, 2021
@tacaswell
Copy link
Member

@tacaswell tacaswell commented Jul 15, 2021

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.

Copy link
Author

@engjellavdiu engjellavdiu left a comment

You are right on all of them

fixed based on suggestions from @tacaswell
@engjellavdiu engjellavdiu requested a review from tacaswell Jul 15, 2021
@engjellavdiu
Copy link
Author

@engjellavdiu engjellavdiu commented Jul 17, 2021

@@ -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,

This comment has been minimized.

@timhoffm

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

This comment has been minimized.

@jklymak

jklymak Jul 21, 2021
Contributor

This whole bullet should just go away as this subdirectory does not exist any longer

Copy link
Contributor

@jklymak jklymak left a comment

This whole file should just be removed, unless I am missing something. README.txt is what gets rendered in the docs.

@jklymak jklymak marked this pull request as draft Jul 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

5 participants