Re: Plea to help flag docs

Hi Anne,

Previously I have made small corrections to the documentation by submitting
a GIT patch-set. In principle, is this somehow inferior to using the
tagging system? It seems easier: correct or expand, then submit to a
maintainer so that it can be validated. It does not seem like more work and
the changes are nicely incremental. Is there something I'm missing?

Cheers,
Boris


On Thu, Jul 11, 2013 at 10:54 AM, Wouter Beek <[email protected]> wrote:

> Hi Anne,
>
> I think this is a very good initiative: using the Prolog community to
> improve the already-quite-good documentation system!
>
> It sometimes occurs to me that predicates are well-documented but that an
> example would greatly ease the use of that predicate by a wider range of
> programmers. Related to this, I often see questions on the Prolog mailing
> list the answers to which could be used to enrich the documentation as well
> (especially when they provide a nice code example of 2 or 3 lines that
> immediately clarifies the problem at hand).
>
> Cheers!,
> Wouter.
>
> On Fri, Jul 5, 2013 at 8:00 PM, Anne Ogborn <[email protected]> wrote:
>
> > A plea to help with documentation.
> >
> > If you find the documentation for a predicate confusing, please tag it
> > with the doc-needs-help using
> > the new tagging system on www.swi-prolog.org
> >
> > When there's enough of these tagged and we find resources to do it, we'll
> > have a push to clean up the
> > docs.
> >
> > A general  cleanup of the site organization, etc. is underway. I started
> > doing this last fall, but was sucked into a contract. I've been desucked
> > and am back on the site.
> >
> > So tag away folks!
> > _______________________________________________
> > SWI-Prolog mailing list
> > [email protected]
> > https://lists.iai.uni-bonn.de/mailman/listinfo.cgi/swi-prolog
> >
> >
> -------------- next part --------------
> HTML attachment scrubbed and removed
> _______________________________________________
> SWI-Prolog mailing list
> [email protected]
> https://lists.iai.uni-bonn.de/mailman/listinfo.cgi/swi-prolog
>
-------------- next part --------------
HTML attachment scrubbed and removed