hdf-compass icon indicating copy to clipboard operation
hdf-compass copied to clipboard

Warnings in sphinx generated manpage

Open ghisvail opened this issue 8 years ago • 0 comments

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.

ghisvail avatar Jul 07 '16 10:07 ghisvail