[petsc-dev] Sowing: proposed change to allow single-entry lists on man pages

Patrick Sanan patrick.sanan at gmail.com
Sat Jun 15 10:15:27 CDT 2019


Lists on the man pages don't seem to be able to have a single entry,
because sowing requires you to start lists with "+" and end them with "-",
requiring at least two entries.

This leads to ugly-looking indentation for man pages for functions with a
single input or output parameter, e.g.
https://www.mcs.anl.gov/petsc/petsc-dev/docs/manualpages/DMSTAG/DMStagVecGetArrayDOF.html

I think that this can be remedied with a small change to sowing (doctext),
to interpret a lone '-' as opening a list (and then closing it after one
entry):
https://bitbucket.org/psanan/sowing/commits/780ea53824388e8c6089ae2d6210332c63935edb

(Posting this here since I'm not sure how closely the
bitbucket.org/petsc/pkg-sowing repository is monitored)
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.mcs.anl.gov/pipermail/petsc-dev/attachments/20190615/13b46bba/attachment.html>


More information about the petsc-dev mailing list