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.

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

Add --docstring-length flag #63

Merged
merged 2 commits into from
Dec 27, 2020
Merged

Add --docstring-length flag #63

merged 2 commits into from
Dec 27, 2020

Conversation

Pacu2
Copy link
Contributor

@Pacu2 Pacu2 commented Dec 24, 2020

close #62

In this PR:

  1. I've added --docstring-length flag to limit editing docstrings to those of given length (especially useful when refactoring big projects)
  2. Added unit tests for this feature and two utils

@coveralls
Copy link

Coverage Status

Coverage decreased (-0.5%) to 99.469% when pulling f45c16d on Pacu2:master into 248f822 on myint:master.

myint
myint approved these changes Dec 27, 2020
View reviewed changes
Copy link
Member

@myint myint left a comment

Choose a reason for hiding this comment

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

Looks good! Thanks!

@myint myint merged commit b87c03a into PyCQA:master Dec 27, 2020
@weibullguy weibullguy added P: enhancement Feature that is outside the scope of PEP 257 C: stakeholder Relates to docformatter stakeholder requested behavior labels Aug 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@myint myint myint approved these changes

Assignees
No one assigned
Labels
C: stakeholder Relates to docformatter stakeholder requested behavior P: enhancement Feature that is outside the scope of PEP 257
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Feature: Add option to reformat docstrings of given length
4 participants
@Pacu2 @coveralls @myint @weibullguy