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

Smith, Barry F. bsmith at mcs.anl.gov
Sat Jun 15 10:54:04 CDT 2019

  Patrick (and Bill)

     Good timing. Bill is actually updating Sowing now and could perhaps fix this glitch. Currently we use a . for a single entry in the list and I'd hate to have to change them all the -. Likely it is possible to fix the formatting for the . case to have the same indent as the + . - cases.


> On Jun 15, 2019, at 10:15 AM, Patrick Sanan via petsc-dev <petsc-dev at mcs.anl.gov> wrote:
> 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)

More information about the petsc-dev mailing list