gandi.cli icon indicating copy to clipboard operation
gandi.cli copied to clipboard

Manual page has some over-long lines

Open bignose-debian opened this issue 6 years ago • 1 comments

The manual page contains some lines that, when rendered to a manual page document, do not fit on a standard 80-column terminal.

In particular:

  • The entry for gandi dns list domain.tld contains the literal text [A|AAAA|CAA|CDS|CNAME|DNAME|DS|LOC|MX|NS|PTR|SPF|SRV|SSHFP|TLSA|TXT|WKS].
  • The entry for gandi domain create domain.tld contains a long URL, http://doc.rpc.gandi.net/domain/reference.html#DomainExtraParameters.

Both of those cause paragraphs that cannot be wrapped to fit correctly on lines.

This can be tested with:

$ LC_ALL=en_US.UTF-8 MANROFFSEQ='' MANWIDTH=80 \
    man --warnings -E UTF-8 -l -Tutf8 -Z <(rst2man gandicli.man.rst) > /dev/null
troff: <standard input>:394: warning [p 8, 10.7i]: can't break line
troff: <standard input>:408: warning [p 9, 6.8i]: can't break line

bignose-debian avatar Apr 03 '19 06:04 bignose-debian

This remains a bug in the document released in version 1.5.

bignose-debian avatar Jun 05 '19 00:06 bignose-debian