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

Fix CONTRIBUTING.rst and mention black #2241

Merged
merged 5 commits into from
Feb 19, 2022

Conversation

adeak
Copy link
Member

@adeak adeak commented Feb 18, 2022

There was some broken formatting left after the markdown -> reST overhaul of the contributing guide. I also don't know why every link has double underlines at the end: as far as I know only one is necessary for links. But the rendered html works fine so I didn't touch these.

I've also added a note about black being in use and changed the make isort suggestion into a make format one.

We should check the doc artifact of this PR before merging to see if I got everything right, I haven't built it locally this time.

@github-actions github-actions bot added the documentation Anything related to the documentation/website label Feb 19, 2022
CONTRIBUTING.rst Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Feb 19, 2022

Codecov Report

Merging #2241 (f50285f) into main (ba5c02e) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #2241   +/-   ##
=======================================
  Coverage   93.30%   93.30%           
=======================================
  Files          75       75           
  Lines       15602    15602           
=======================================
  Hits        14558    14558           
  Misses       1044     1044           

CONTRIBUTING.rst Outdated Show resolved Hide resolved
Copy link
Member

@tkoyama010 tkoyama010 left a comment

Choose a reason for hiding this comment

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

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Anything related to the documentation/website
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants