Re: Feature request: api docs

[Patrice Dumas]

On Mon, Feb 07, 2022 at 08:30:15AM +0000, Reißner Ernst wrote:
> 
> Well, I think texinfo was used for general api docs but mostly lisp. 
> I think you are right, there are many features which allow also formatting 
> Of api docs, but as you say, without semantics. 
> I think it is a bad idea, to put parameters in a table. 
> Relevant is that there is a parameter. 
> That way another tool can also check whether docs is complete and consistent 
> With the code.

If this is the issue, I do not think that having specific formatting in
Texinfo is the way to go.  If you look at the numpydoc example, there is
no semantic formatting at all.  It is reStructuredText without
semantics.  The semantics are added by the specific names used in the
text, and a structure is mandated too (maybe more for easy parsing
than for the semantics).  This can already be done in Texinfo and should
probably be done that way, as there is no way Texinfo could have
specific markup adapted to all the languages.

-- 
Pat