<div dir="ltr"><div dir="ltr">Looks great! </div></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">Am Di., 2. Juli 2019 um 17:06 Uhr schrieb Balay, Satish <<a href="mailto:balay@mcs.anl.gov">balay@mcs.anl.gov</a>>:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-style:solid;border-left-color:rgb(204,204,204);padding-left:1ex">Patrick,<br>
<br>
PR is now at: <a href="https://bitbucket.org/petsc/petsc/pull-requests/1838/fixes-for-doctext-update/diff" rel="noreferrer" target="_blank">https://bitbucket.org/petsc/petsc/pull-requests/1838/fixes-for-doctext-update/diff</a><br>
<br>
Satish<br>
<br>
<br>
On Sat, 29 Jun 2019, Patrick Sanan via petsc-dev wrote:<br>
<br>
> That's great! That'll go a long way towards making the man pages look<br>
> neater - I'm happy to review the PR that updates the arg lists on the man<br>
> pages - is your branch off of master (and thus can be submitted with the<br>
> usual procedure of a pull request on bitbucket)?<br>
> <br>
> Am Di., 25. Juni 2019 um 09:05 Uhr schrieb Gropp, William D <<br>
> <a href="mailto:wgropp@illinois.edu" target="_blank">wgropp@illinois.edu</a>>:<br>
> <br>
> > Thanks for this suggestion.  The + and - were added to make it easier to<br>
> > generate a nicely formatted list, though its possible to look for<br>
> > transitions from non-list to list and back to non-list.  Think of + as<br>
> > similar to \begin{description}\item … and - as \item … \end{description}.<br>
> ><br>
> > I’ve updated doctext to allow both - and a isolated . for an argument<br>
> > description. In the process of doing this, I added checks for errors in the<br>
> > use of the doctext formatting, and found many minor errors, as well as<br>
> > updating the old arg lists that didn’t use the + .. - . I have a branch for<br>
> > petsc that fixes all of those (it was the easiest way for me to be sure my<br>
> > doctext fixes worked) that will need to be merged.  Let me know how you’d<br>
> > like me to submit that. There are also many malformed entries where there<br>
> > is no description.  I’ve turned those warnings off by default, but<br>
> > -Wargdesc will warn for each argument that is missing a description; some<br>
> > of these should use different formatting instead of the argument lists.<br>
> ><br>
> > The new version, in sowing-1.1.26, also has updates to bfort (which<br>
> > requires the patch that I sent earlier to bin/maint/generatefortranstubs.py<br>
> > ) and other miscellaneous fixes.  I’ve uploaded this version to my web page<br>
> > and it is the default when you download sowing.tar.gz .  I am unable to<br>
> > update the confdb macros to fix errors in them - the permissions have<br>
> > changed on the repository (for my own files!).  Because of that and other<br>
> > problems, I plan to move sowing to a git repository that I fully control<br>
> > soon; this weekend if I can.<br>
> ><br>
> > Let me know if you have any problems.<br>
> ><br>
> > Bill<br>
> ><br>
> > William Gropp<br>
> > Director and Chief Scientist, NCSA<br>
> > Thomas M. Siebel Chair in Computer Science<br>
> > University of Illinois Urbana-Champaign<br>
> ><br>
> ><br>
> ><br>
> ><br>
> ><br>
> ><br>
> > On Jun 15, 2019, at 12:06 PM, Smith, Barry F. <<a href="mailto:bsmith@mcs.anl.gov" target="_blank">bsmith@mcs.anl.gov</a>> wrote:<br>
> ><br>
> ><br>
> ><br>
> > On Jun 15, 2019, at 11:57 AM, Patrick Sanan <<a href="mailto:patrick.sanan@gmail.com" target="_blank">patrick.sanan@gmail.com</a>><br>
> > wrote:<br>
> ><br>
> > Great! I'll leave that commit there for reference, but as you say it would<br>
> > be even nicer (but more coding) to avoid needing to explicitly mark the<br>
> > starts and ends of lists.<br>
> ><br>
> ><br>
> >   Yeah, I only remember vaguely that initially we didn't use the + and -<br>
> > on the lists and there was some issue so they were introduced.<br>
> ><br>
> >  Barry<br>
> ><br>
> ><br>
> > Am Sa., 15. Juni 2019 um 17:54 Uhr schrieb Smith, Barry F. <<br>
> > <a href="mailto:bsmith@mcs.anl.gov" target="_blank">bsmith@mcs.anl.gov</a>>:<br>
> ><br>
> >  Patrick (and Bill)<br>
> ><br>
> >     Good timing. Bill is actually updating Sowing now and could perhaps<br>
> > fix this glitch. Currently we use a . for a single entry in the list and<br>
> > I'd hate to have to change them all the -. Likely it is possible to fix the<br>
> > formatting for the . case to have the same indent as the + . - cases.<br>
> ><br>
> >   Barry<br>
> ><br>
> > On Jun 15, 2019, at 10:15 AM, Patrick Sanan via petsc-dev <<br>
> > <a href="mailto:petsc-dev@mcs.anl.gov" target="_blank">petsc-dev@mcs.anl.gov</a>> wrote:<br>
> ><br>
> > Lists on the man pages don't seem to be able to have a single entry,<br>
> > because sowing requires you to start lists with "+" and end them with "-",<br>
> > requiring at least two entries.<br>
> ><br>
> > This leads to ugly-looking indentation for man pages for functions with a<br>
> > single input or output parameter, e.g.<br>
> > <a href="https://www.mcs.anl.gov/petsc/petsc-dev/docs/manualpages/DMSTAG/DMStagVecGetArrayDOF.html" rel="noreferrer" target="_blank">https://www.mcs.anl.gov/petsc/petsc-dev/docs/manualpages/DMSTAG/DMStagVecGetArrayDOF.html</a><br>
> ><br>
> > I think that this can be remedied with a small change to sowing (doctext),<br>
> > to interpret a lone '-' as opening a list (and then closing it after one<br>
> > entry):<br>
> > <a href="https://bitbucket.org/psanan/sowing/commits/780ea53824388e8c6089ae2d6210332c63935edb" rel="noreferrer" target="_blank">https://bitbucket.org/psanan/sowing/commits/780ea53824388e8c6089ae2d6210332c63935edb</a><br>
> ><br>
> > (Posting this here since I'm not sure how closely the<br>
> > <a href="http://bitbucket.org/petsc/pkg-sowing" rel="noreferrer" target="_blank">bitbucket.org/petsc/pkg-sowing</a> repository is monitored)<br>
> ><br>
> ><br>
> ><br>
> ><br>
> ><br>
> </blockquote></div>