Tim Landscheidt <[email protected]> writes:

> I wish I could :-).  The last time I glanced at IIRC
> ob-shell's code ...

Well. That one is quite complex.
Try something like ob-awk for simpler example or ob-sql itself, if you
want to work with that.

> Just now (again, with only minimal effort) I found
> https://orgmode.org/worg/org-contrib/babel/languages/(*1)
> referring to ob-template.el which (CMIIW) does not contain
> any explanation either.

What do you mean? I think that code is quite well-commented.

> So the learning curve is rather steep for casual passersby.

If you want some easier way to get started, you can try
https://orgmode.org/worg/orgdevmeetup.html

You can also ask questions here, if there is something specific you want
to ask. See also https://orgmode.org/worg/org-contribute.html

> (*1)   Org mode's scattering of documentation on an external
>        website and everywhere is not unique, yet still
>        frustrating, especially for an extension to a
>        "self-documenting editor".  Why is information that
>        the user needs (is it "postgres" or "postgresql"?)
>        for using ob-sql at
>        https://orgmode.org/worg/org-contrib/babel/languages/ob-doc-sql.html
>        and neither in the Org mode manual nor in something
>        else apart from a very terse comment at the start of
>        ob-sql?  Why are the "Examples Of Use" at the website
>        not about specifically using ob-sql (how many queries
>        can be run in a source block, and how do I manage the
>        table not being mangled by bits in ~/.psqlrc?), but
>        rather about bog-standard noweb stuff?
>        "<<quote-blks("my-query")>>" evaluating to "nil"
>        looks like a mistake.  Also, IIRC one can just
>        verbatim insert a source block in another source
>        block with "<<my-query>>".  Is this some R issue that
>        needs to be worked around?  Shouldn't it rather be
>        documented there?

If you have suggestions how to improve documentation, feel free to
propose changes.
As for babel docs living on wiki, we are working towards moving the
babel documentation to the manual. See
https://list.orgmode.org/87zfl3uxhb.fsf@localhost/

-- 
Ihor Radchenko // yantar92,
Org mode maintainer,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>

Reply via email to