Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Use checkboxes as bullet points for the PR review checklists #15349

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Apr 13, 2020
Merged

Use checkboxes as bullet points for the PR review checklists #15349

merged 1 commit into from
Apr 13, 2020

Conversation

timhoffm
Copy link
Member

@timhoffm timhoffm commented Sep 30, 2019 •
edited
Loading

PR Summary

This is intended as a visual aid as proposed in #15324 (comment). Ping @story645

There are other ways to achieve similar behavior, but the proposed solution seems best to me.

Just for reference here are the other alternatives:

rst-class with .css file

Essentially the same as this one but the CSS is not defined inline via <style> but in a .css file.
Advantage: Less clutter in the .rst file. Disadvantage: The CSS styling is far away from it's usage future changes may not be aware of this relation and accidentially break it.

Faking a box using square brackets

* [ ] Is the feature / bugfix reasonable?
Advantage: No extra formatting. Disadvantage: Doesn't look good.

Adding a checkbox to the list

* |checkbox| Is the feature / bugfix reasonable?
* |checkbox| ...

.. |checkbox| unicode:: U+02751

Advantage: No no style changes necessary. Disadvantage: The checkbox does not replace the bullet point but is placed after it.

@QuLogic
Copy link
Member

QuLogic commented Mar 26, 2020

https://25385-1385122-gh.circle-artifacts.com/0/home/circleci/project/doc/build/html/devel/coding_guide.html

This needs at least an en-space of padding after the checkbox.

@QuLogic QuLogic requested a review from story645 March 26, 2020 00:38
story645
story645 requested changes Mar 26, 2020
View reviewed changes
Copy link
Member

@story645 story645 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yay, thanks! I agree with @QuLogic on the need for a space.
That also might help with the shadow effect looking a little strong here: (I'm not a fan, but the box style is not a blocker for me). My preference would be ☐ U+2610
image

@timhoffm
Copy link
Member Author

Miracles of sphinx: built docs

Sphinx adds <p> in the <li> elements of the first bullet list, causing a new line after the bullet marker. It does not do so for the other two lists, which render as desired. 🤷‍♂️

@timhoffm timhoffm added this to the v3.3.0 milestone Apr 11, 2020
@timhoffm
Copy link
Member Author

ping @story645

@story645 story645 merged commit 9be011d into matplotlib:master Apr 13, 2020
@timhoffm timhoffm deleted the pr-checklist branch April 13, 2020 20:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@story645 story645 story645 approved these changes

Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
v3.3.0
Development

Successfully merging this pull request may close these issues.
3 participants
@timhoffm @QuLogic @story645