Option to not format module description docstring
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 598
- Forks
- 93
- PR merge metrics
- No merged PRs in 30d
Description
My organisation currently has a license header which doesn't conform to PEP 257, but I'd love to use docformatter for the rest of the module's contents.
I attempted to do this using the range option, but since the module description string also contains the module's description, one can know a minimum length for them, but not a maximum length.
It would be really great if docformatter had an option to toggle formatting of these module docstrings.
Thanks!
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No files or tests are named in the issue. Start by locating docformatter's option parsing and the code that formats module description docstrings, then inspect existing tests for formatting options. Done means a user-configurable option skips the module description docstring while other docstrings in the module remain formatted.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100