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

Add black-doc to pre-commit #4120

Merged
merged 8 commits into from Mar 19, 2023
Merged

Add black-doc to pre-commit #4120

merged 8 commits into from Mar 19, 2023

Conversation

akaszynski
Copy link
Member

Redo of #4119 whereby only black doc is added. Style check is expected to fail. We will have a follow up PR implementing the style changes.

@github-actions github-actions bot added the documentation Anything related to the documentation/website label Mar 11, 2023
@codecov
Copy link

codecov bot commented Mar 11, 2023

Codecov Report

Merging #4120 (8b6115f) into main (a693f8d) will increase coverage by 0.00%.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #4120   +/-   ##
=======================================
  Coverage   95.57%   95.57%           
=======================================
  Files          95       95           
  Lines       20250    20282   +32     
=======================================
+ Hits        19353    19384   +31     
- Misses        897      898    +1     

.pre-commit-config.yaml Outdated Show resolved Hide resolved
tkoyama010
tkoyama010 previously approved these changes Mar 12, 2023
Copy link
Member

@adeak adeak left a comment

Choose a reason for hiding this comment

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

Let's hold back on this until any issues regarding #4119 are settled and git blame ignore revs items are added here.

@akaszynski
Copy link
Member Author

akaszynski commented Mar 13, 2023

Reminder to add:


[tool.blackdoc]
# From https://numpydoc.readthedocs.io/en/latest/format.html
# The length of docstring lines should be kept to 75 characters to facilitate
# reading the docstrings in text terminals.
line-length = 75

to pyproject.toml

@akaszynski
Copy link
Member Author

Let's hold back on this until any issues regarding #4119 are settled and git blame ignore revs items are added here.

Changes addressed in #4125

@tkoyama010
Copy link
Member

@adeak Could you approve this? I cannot wait using black-doc 🙂

@akaszynski
Copy link
Member Author

git blame ignore revs items are added here

I still have to add these. Will do today.

@adeak
Copy link
Member

adeak commented Mar 17, 2023

Also #4120 (comment).

@akaszynski
Copy link
Member Author

Should be good to go @adeak.

.git-blame-ignore-revs Outdated Show resolved Hide resolved
@adeak adeak self-requested a review March 19, 2023 00:05
Co-authored-by: Andras Deak <adeak@users.noreply.github.com>
@akaszynski akaszynski merged commit 1e84e8e into main Mar 19, 2023
21 checks passed
@akaszynski akaszynski deleted the docs/add-blackdoc-pre-commit branch March 19, 2023 20:11
@akaszynski akaszynski mentioned this pull request Apr 30, 2023
6 tasks
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

3 participants