Documentation of node_teaser() - 'in a given format' is confusing

I think you misunderstood the documentation -- although, arguable it's not very clear.

Index: node.module
===================================================================
RCS file: /cvs/drupal/drupal/modules/node/node.module,v
retrieving revision 1.882
diff -r1.882 node.module
241c241
<  * Automatically generate a teaser for a node body in a given format.
---
>  * Automatically generate a teaser for a node body.

related: http://drupal.org/node/180425

Needs a real patch in unified diff format:
http://drupal.org/patch/create

here's a patch

Changed title to reflect the focus of this issue.

Related questions: is the fact that for PHP input format pages that actually contain PHP code the teaser is always the same as the entire body made clear to the end user? Also that Drupal tries to slice the main body text at a paragraph break to generate the teaser, and that multibyte characters count as multiple characters when calculating the teaser length. These probably belong in new issue(s). [edited]

Hmmm not sure there is much actual improvement going on here :/ !!

Previous patch no longer worked since documentation of node_teaser() had been updated. Here's a new one.

IMHO "in a given format" only means that you need to pass on the format (for checking for the PHP format). Otherwise teaser generation is the same in all formats.

Agreed ... I think the point it that "in a given format" does not add anything to "Automatically generate a teaser for a node body" - it only confuses, especially since the argument $format is clearly defined now in the documentation.

Thanks, committed.