view release on metacpan or  search on metacpan

html/about.pod  view on Meta::CPAN

One difference is that notes in AnnoCPAN belong to specific paragraphs instead
of chapters, and they are shown on the margin (or between paragraphs, depending
on the style sheet) instead of at the bottom of the page.

=head2 How does it work?

The AnnoCPAN site has the documentation for all the CPAN modules, and a 
database of "notes" that can be added through the web interface. When
a user views a module's documentation, the POD is shown as HTML together 
with the notes. This allows users to write very short notes that fill gaps
in the documentation; for example, it might be sufficient to say "warning:
this method returns different things in scalar and in list context and the POD
doesn't mention it!".

The plan is to make the note database available for download under an open
license so that other CPAN sites can choose to show the notes. It  might also
be possible to create a program to patch the local pods in a user's machine so 
that the notes appear on perldoc! (Clearly labeled as notes, of course).

=head2 The problem with versions

tt/faq.html  view on Meta::CPAN

href="/~itub">ITUB</a> on CPAN).  The Perl Foundation provided a grant to
encourage him to finish and help pay for some of the expenses.
</p>

<a name="how"></a><h3>How does it work?</h3>

<p>The AnnoCPAN site has the documentation for all the CPAN modules, and a 
database of "notes" that can be added through the web interface. When
a user views a module's documentation, the POD is shown as HTML together 
with the notes. This allows users to write very short notes that fill gaps
in the documentation; for example, it might be sufficient to say "warning:
this method returns different things in scalar and in list context and the POD
doesn't mention it!".</p>

<a name="others"></a><h3>How does this site relate with CPAN::Forum, CPANRatings, search.cpan.org,
PerlMonks...?</h3>

<p>The goals of AnnoCPAN and all these sites overlap to varying degrees, but 
each one fills a different niche:</p>

<ul>

tt/faq.html  view on Meta::CPAN

<h2>Technical</h2>

<a name="conf"></a><h3>What's the %confidence?</h3>

<p>When a note is added to a document, the software tries to guess where
would the same note go in other versions of the same document. This is based
on a text similarity analysis which provides a quantitative estimate
expressed as a percentage.</p>

<p>For example, let's say that you add a note to My::Module in My-Dist-0.10,
next to a paragraph that says "this is a paragraph". When version 0.20 comes
out, let's say that the paragraph moved and was modified to say "this is
one paragraph". The similarity search decides that this is still the same
paragraph with a confidence of 95% and assigns the note accordingly.</p>

<a name="absurd"></a><h3>A note is in an absurd place! Why's that?</h3>

<p>The notes are assigned to other versions of the document by using the method
discussed above. As with all heuristics, there will be mistakes, especially
when a paragraph is completely deleted or modified very heavily. In these cases
it is necessary to move the note manually or hide it if it no longer
applies.</p>