manual line break check should skip multi-line html comments
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 617
- Forks
- 724
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 223
Description
I got this error in https://github.com/pingcap/docs-cn/pull/12161/commits/25c241a45d577237f2d274ea68dcbf19b194d35e#diff-843fc0a482bc858491854387363a576e09fe417876bc90e0d168b6ff1b8168c7:
[2022-11-30T07:44:56.895Z] faq/deploy-and-maintain-faq.md: this file has manual line breaks in the following lines:
[2022-11-30T07:44:56.895Z]
[2022-11-30T07:44:56.895Z] MANUAL LINE BREAKS: L27
[2022-11-30T07:44:56.895Z] MANUAL LINE BREAKS: L28
for this comment:
It doesn't make sense to check manual line breaks in comments. All comments should be skipped.
The check script: https://github.com/pingcap/docs/blob/master/scripts/check-manual-line-breaks.py
Contributor guide
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
Start with scripts/check-manual-line-breaks.py and reproduce the reported warning using the multi-line HTML comment in faq/deploy-and-maintain-faq.md. Update the check so manual line breaks inside comments are skipped, then verify that the example no longer reports L27 and L28 while other manual line breaks are still checked.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 52/100