Warnings in sphinx generated manpage
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 35/100
- Issue type
- Bug
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- python
- Domain
- documentation
Research direction
Run sphinx-build -N -b man docs build/man, then check build/man/hdfcompass.1 with the provided man --warnings command. Inspect the documentation inputs under docs around the generated content corresponding to the reported lines, and verify that the four formatting warnings are gone.
Written by the indexing model from the issue text.
Description
The manpage for hdfcompass produced by:
sphinx-build -N -b man docs build/man
has formatting warnings according to the Debian linting tool.
It uses the output of the following command:
MANROFFSEQ='' MANWIDTH=80 man --warnings -E UTF-8 -l -Tutf8 -Z ./build/man/hdfcompass.1 >/dev/null
<standard input>:113: warning [p 2, 2.0i]: cannot adjust line
<standard input>:120: warning [p 2, 3.7i]: can't break line
<standard input>:148: warning [p 2, 8.0i]: can't break line
<standard input>:161: warning [p 2, 10.3i]: cannot adjust line
which lists 4 warnings.
I understand that the content of the documentation is still work-in-progress, so fixing this issue may be considered low-priority.
- Dominant language
- Python
- Stars
- 132
- Forks
- 27
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
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.
More from HDFGroup/hdf-compass
-
FlatpakOpen
Difficulty 3/5 1-2 days Newbie friendliness 20/100
HDFGroup/hdf-compass#214 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
HDFGroup/hdf-compass#209 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
HDFGroup/hdf-compass#208 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 42/100
HDFGroup/hdf-compass#207 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
HDFGroup/hdf-compass#206 ·
All issues in HDFGroup/hdf-compass
Similar issues
-
AI bug
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
AUTO-MAS-Project/AUTO-MAS#1960 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
btclib-org/btclib-wallet#872 ·
Maintainers usually reply within 1 day
-
[Bug]: Scheduled returns scan all accepted minion keys causing extreme loadPossibly taken A pull request linked to this issue is open or already merged. Openbug needs-triage
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
saltstack/salt#70789 · 1 comment ·
Maintainers usually reply within 3 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 87/100
btclib-org/btclib#3093 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Maintainers usually reply within 1 day