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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

docformatter: config with black #1909

Merged
merged 16 commits into from
Jul 24, 2023
Merged

docformatter: config with black #1909

merged 16 commits into from
Jul 24, 2023

Conversation

Borda
Copy link
Member

@Borda Borda commented Jul 12, 2023

What does this PR do?

Fixes #<issue_number>

Before submitting
  • Was this discussed/agreed via a Github issue? (no need for typos and docs improvements)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure to update the docs?
  • Did you write any new necessary tests?
PR review

Anyone in the community is free to review the PR once the tests have passed.
If we didn't discuss your PR in Github issues there's a high chance it will not be merged.

Did you have fun?

Make sure you had fun coding 馃檭


馃摎 Documentation preview 馃摎: https://torchmetrics--1909.org.readthedocs.build/en/1909/

@pre-commit-ci pre-commit-ci bot requested a review from lantiga as a code owner July 12, 2023 13:36
@Borda Borda marked this pull request as draft July 12, 2023 13:40
@Borda
Copy link
Member Author

Borda commented Jul 12, 2023

seems that the 120 lengths is recognized :/

UPDATE: PyCQA/docformatter#172

@Borda Borda marked this pull request as ready for review July 12, 2023 14:08
@Borda Borda enabled auto-merge (squash) July 12, 2023 14:43
@Borda Borda added the documentation Improvements or additions to documentation label Jul 12, 2023
@codecov
Copy link

codecov bot commented Jul 12, 2023

Codecov Report

Merging #1909 (68e27a0) into master (2774387) will not change coverage.
The diff coverage is 100%.

Additional details and impacted files
@@          Coverage Diff           @@
##           master   #1909   +/-   ##
======================================
  Coverage      85%     85%           
======================================
  Files         263     263           
  Lines       15061   15061           
======================================
  Hits        12809   12809           
  Misses       2252    2252           

pyproject.toml Outdated Show resolved Hide resolved
@SkafteNicki
Copy link
Member

@Borda pretty sure we need to add

[tool.docformatter]
recursive = true
wrap-summaries = 120
wrap-descriptions = 120
blank = true

to pyproject.toml to get it working.

@Borda
Copy link
Member Author

Borda commented Jul 17, 2023

pretty sure we need to add

yes, bad collision resolving, sorry

@Borda Borda requested a review from SkafteNicki July 17, 2023 18:02
@mergify mergify bot added the ready label Jul 19, 2023
@Borda Borda disabled auto-merge July 24, 2023 19:48
@Borda Borda merged commit a9d9280 into master Jul 24, 2023
64 checks passed
@Borda Borda deleted the docformatter branch July 24, 2023 19:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation ready
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants