Re: New Package Documentation

Chuck Cook <[email protected]> Thu, 01 Oct 2020 14:53:59 -0400
Newsgroups gmane.comp.gnu.octave.maintainers
Message-ID <[email protected]>
I am referring to package documentation.  I want to include brief
examples, possibly a tiny bit of theory.
On Thu, 2020-10-01 at 13:48 +0900, Kai Torben Ohlhus wrote:
> On 9/30/20 9:20 PM, Chuck Cook wrote:
> > I picked this link out of one of the other threads.
> > https://github.com/gnu-octave/pkg-example
> > 
> > My question is:How is new package documentation tied into the
> > regular octavedocumentation?  I see packages that obviously have
> > had a lot of work putinto them.  But how to use them is cryptic and
> > superficial.
> > Chuck
> 
> Thank you for your interest.  The "pkg-example" [1] is created
> accordingto the only and official Octave package documentation in the
> manual [2]. Thus using "pkg-example" (also outside GitHub) you do not
> need to worryto miss something important that Octave's "pkg" cannot
> install it properly.
> As an example it serves to demonstrate the bare necessary
> minimum.  Andyes, developing "simple" Octave packages is
> astonishingly simple 😉
> Depending on your needs and package purpose, those packages can
> ofcourse increase (dramatically) in complexity, e.g.
> "bootstrap","configure.ac", ...  But all this is not necessary for
> the start andshould best be avoided to reduce the maintenance burden
> current packagesare suffering from.
> > But how to use them is cryptic and superficial.
> 
> What do you mean by this?  Do you mean lack of package documentation?
> HTH,Kai
> [1] https://github.com/gnu-octave/pkg-example
> [2] https://octave.org/doc/v5.2.0/Creating-Packages.html