HDFGroup / HDFGroup/hdf-compass
Warnings in sphinx generated manpage
- Dominant language
- Python
- Stars
- 132
- Forks
- 27
- PR merge metrics
- No merged PRs in 30d
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
:113: warning [p 2, 2.0i]: cannot adjust line
:120: warning [p 2, 3.7i]: can't break line
:148: warning [p 2, 8.0i]: can't break line
: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.
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.