Skip to content

Add explanatory comments to the example on plotting categorical variables #22031

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

Conversation

ruthgn
Copy link
Contributor

@ruthgn ruthgn commented Dec 21, 2021

PR Summary

Add explanatory comments to the example on plotting categorical variables. PR related to issue #11654.

PR Checklist

Tests and Styling

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

Documentation

  • New features are documented, with examples if plot related.
  • 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).
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).

Add explanatory comments to the example on plotting categorical variables
@ruthgn ruthgn changed the title Update categorical_variables.py Add explanatory comments to the example on plotting categorical variables Dec 21, 2021
@jklymak
Copy link
Member

jklymak commented Jan 5, 2022

Again I'm against micro-commenting like this. I think python is expressive enough that these comments are obvious, and if we encourage this, there will be 1000 PRs like this; we have enough problem dealing with the substantive PRs.

@ruthgn, I am not trying to discourage you personally - I hope you keep submitting PRs. However, I would encourage you to find examples that would be confusing to someone with passing familiarity with numpy and Matplotlib i.e. the audience should be assumed to have at least read https://matplotlib.org/stable/tutorials/introductory/usage.html If we can't assume that level of knowledge, our docs will become very distracting with basic explanations.

@timhoffm had a reasonable set of guidelines here, but in particular: "... do not clutter the code with too many comments."

@ruthgn
Copy link
Contributor Author

ruthgn commented Jan 5, 2022

@jklymak, no problem. I appreciate the helpful feedback! Will submit PRs that are aligned with these expectations next time.

@ruthgn ruthgn closed this Jan 5, 2022
@ruthgn ruthgn deleted the explain_plotting_categorical_var_example branch January 5, 2022 15:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants