Title underlines too short
- Dominant language
- Python
- Stars
- 6
- Forks
- 7
- PR merge metrics
- No merged PRs in 30d
Description
A whole bunch of files have title underlines that are too sort: Fix them by making them longer!
````
WARNING ./Metadata/CommitMessage/Shortlog/Length/README.rst:48 Title underline too short.
WARNING ./Metadata/CommitMessage/Shortlog/Length/README.rst:48 Title underline too short.
WARNING ./Metadata/CommitMessage/Shortlog/Tense/README.rst:49 Title underline too short.
WARNING ./Metadata/CommitMessage/Shortlog/Tense/README.rst:49 Title underline too short.
WARNING ./Metadata/CommitMessage/Shortlog/FirstCharacter/README.rst:54 Title underline too short.
WARNING ./Metadata/CommitMessage/Shortlog/FirstCharacter/README.rst:54 Title underline too short.
WARNING ./Metadata/CommitMessage/Shortlog/TrailingPeriod/README.rst:50 Title underline too short.
WARNING ./Metadata/CommitMessage/Shortlog/TrailingPeriod/README.rst:50 Title underline too short.
WARNING ./Metadata/CommitMessage/Shortlog/ColonExistence/README.rst:51 Title underline too short.
WARNING ./Metadata/CommitMessage/Shortlog/ColonExistence/README.rst:51 Title underline too short.
WARNING ./Metadata/CommitMessage/Emptiness/README.rst:34 Title underline too short.
WARNING ./Metadata/CommitMessage/Emptiness/README.rst:34 Title underline too short.
WARNING ./Metadata/CommitMessage/Body/Length/README.rst:49 Title underline too short.
WARNING ./Metadata/CommitMessage/Body/Length/README.rst:49 Title underline too short.
WARNING ./Metadata/CommitMessage/Body/Existence/README.rst:33 Title underline too short.
WARNING ./Metadata/CommitMessage/Body/Existence/README.rst:33 Title underline too short.
WARNING ./Redundancy/UnusedImport/README.rst:39 Title underline too short.
WARNING ./Redundancy/UnusedImport/README.rst:39 Title underline too short.
WARNING ./Redundancy/UnusedVariable/UnusedParameter/README.rst:34 Title underline too short.
WARNING ./Redundancy/UnusedVariable/UnusedParameter/README.rst:34 Title underline too short.
WARNING ./Redundancy/UnusedVariable/UnusedLocalVariable/README.rst:35 Title underline too short.
WARNING ./Redundancy/UnusedVariable/UnusedLocalVariable/README.rst:35 Title underline too short.
WARNING ./Redundancy/UnusedVariable/README.rst:35 Title underline too short.
WARNING ./Redundancy/UnusedVariable/README.rst:35 Title underline too short.
WARNING ./Redundancy/UnusedVariable/UnusedGlobalVariable/README.rst:34 Title underline too short.
WARNING ./Redundancy/UnusedVariable/UnusedGlobalVariable/README.rst:34 Title underline too short.
WARNING ./Redundancy/Clone/README.rst:64 Title underline too short.
WARNING ./Redundancy/Clone/README.rst:64 Title underline too short.
WARNING ./Redundancy/UnreachableCode/UnreachableStatement/README.rst:35 Title underline too short.
WARNING ./Redundancy/UnreachableCode/UnreachableStatement/README.rst:35 Title underline too short.
WARNING ./Redundancy/UnreachableCode/UnusedFunction/README.rst:37 Title underline too short.
WARNING ./Redundancy/UnreachableCode/UnusedFunction/README.rst:37 Title underline too short.
WARNING ./Redundancy/UnreachableCode/README.rst:41 Title underline too short.
WARNING ./Redundancy/UnreachableCode/README.rst:41 Title underline too short.
WARNING ./Redundancy/README.rst:26 Title underline too short.
WARNING ./Redundancy/README.rst:26 Title underline too short.
````
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with the README.rst files named in the warning list, such as Redundancy/README.rst and Metadata/CommitMessage/Shortlog/Length/README.rst. Check each title and extend its underline to match the title length. Done means the listed README.rst files no longer produce “Title underline too short” warnings.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 68/100