[documentation] API documentation for dev, not docs?

[Heine Deelstra]

On Tue, 20 Jun 2006 08:55:31 +0200, Anisa <mystavash at animecards.org> wrote:

> So, on one issue, I think it was something about the form textfield
> something or other (http://drupal.org/node/19441), I was simply updating  
> the
> link to the new API, and Dries said that, quote "The only way to fix API
> documentation, is by submitting a patch against
> Drupal core.  This is not an issue for the documentation team so feel  
> free
> to move it to the Drupal project instead."
>
> So, that makes sense to me, OK, but I know I've seen API issues moved to
> docs because it was documentation so what's the consensus?  If we can all
> agree, then http://drupal.org/node/24572 should be updated.  There are  
> maybe
> half a dozen API issues in docs not getting much love, I wouldn't want  
> them
> to just get shifted to dev, only to have a dev person say this is docs.
> It'd be kinda silly.

Hi Anisa,

There are actually two parts to documentation in CVS; the autogenerated  
API docs (from certain comments) and the docs that reside in CVS. The  
first can only be updated with a patch to core, because the core code  
contains these remarks and docs are generated from it. The second can be  
updated by generating a patch against the documentation files itself.

See for example http://drupal.org/node/70027

Regards,

Heine