[petsc-dev] Documenting types of examples

[Patrick Sanan]

I notice that all 4 of those things appear with "!" in front of them in the
linked example file.

My quick guess is that it's getting confused somehow and interpreting the
example as Fortran, where the relevant documentation would be in lines
starting with "!".

I didn't even realize before now that there were perl scripts in PETSc, and
I'm not good at working with them, but this line looks like it might be the
immediate cause:
https://bitbucket.org/petsc/petsc/src/dff330877548dfcdd1a83afa099996c64fa4b077/lib/petsc/bin/maint/getexlist#lines-75


Am Sa., 1. Juni 2019 um 08:06 Uhr schrieb Smith, Barry F. <
bsmith at mcs.anl.gov>:

>
>   Sorry, should have sent the link:
> https://www.mcs.anl.gov/petsc/petsc-dev/docs/manualpages/concepts/dmda.html
>
>
> > On May 31, 2019, at 12:19 PM, Patrick Sanan <patrick.sanan at gmail.com>
> wrote:
> >
> > I don't see actually see that - is it on a local help.html for you, or
> somewhere else?
> >
> > Am Fr., 31. Mai 2019 um 16:36 Uhr schrieb Smith, Barry F. <
> bsmith at mcs.anl.gov>:
> >
> >    Cool stuff.
> >
> >    This is kind of weird
> >
> > ex18.c
> > single
> > single
> > single
> > single
> >
> >    I guess that example has no help string?
> >
> > > On May 31, 2019, at 8:35 AM, Patrick Sanan via petsc-dev <
> petsc-dev at mcs.anl.gov> wrote:
> > >
> > > I guess right now it's just tags which can be of the form tag^sub-tag,
> and you're only allowed to look up one tag at a time (by scrolling through
> that html page). Not ideal but pretty low-maintenance?
> > >
> > > Am Fr., 31. Mai 2019 um 15:15 Uhr schrieb Matthew Knepley <
> knepley at gmail.com>:
> > > On Fri, May 31, 2019 at 9:11 AM Patrick Sanan <patrick.sanan at gmail.com>
> wrote:
> > > We only removed the Concepts from the man pages. The Concepts in the
> examples should remain, and are compiled as usual here :
> https://www.mcs.anl.gov/petsc/petsc-dev/docs/manualpages/help.html
> > >
> > > Does that suffice for what you'd like to add?
> > >
> > > I think so.
> > >
> > > Although right now the hierarchical organization is nonsensical. Why
> would there be a "Laplacian" under KSP, and also
> > > at the top level? It should just be tags, like email, so a user can
> select the set of tags they are looking for.
> > >
> > >    Matt
> > >
> > > Am Fr., 31. Mai 2019 um 15:08 Uhr schrieb Matthew Knepley <
> knepley at gmail.com>:
> > > How should we document the types of examples we have, now that we
> removed Concepts?
> > > For example, I would like it to be easy to see that I have FEM
> examples for
> > >
> > >   - Poisson
> > >   - p-Laplacian
> > >   - Linear elasticity
> > >   - Large deformation elasticity
> > >   - Stokes
> > >   - variable-viscosity Stokes
> > >   - Heat equation
> > >   - Navier-Stokes
> > >
> > > Where would someone see this? Clearly, we want similar lists for other
> examples.
> > >
> > >   Thanks,
> > >
> > >     Matt
> > >
> > > --
> > > What most experimenters take for granted before they begin their
> experiments is infinitely more interesting than any results to which their
> experiments lead.
> > > -- Norbert Wiener
> > >
> > > https://www.cse.buffalo.edu/~knepley/
> > >
> > >
> > > --
> > > What most experimenters take for granted before they begin their
> experiments is infinitely more interesting than any results to which their
> experiments lead.
> > > -- Norbert Wiener
> > >
> > > https://www.cse.buffalo.edu/~knepley/
> >
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.mcs.anl.gov/pipermail/petsc-dev/attachments/20190601/15e1a8b7/attachment.html>