SEE ALSO
Opened this issue · 6 comments
regarding the F77.pm SEE ALSO section, I would prefer simply the following.
L<PDL> (PDL::Minuit and PDL::Slatec), L<PGPLOT>
I'd suggest more explanatory text like 'This module is used by ...'
A brief and random review of some MetaCPAN modules, including some PDL dependency modules, where a SEE ALSO section is present in a .pm file, indicates that such sections often solely list other MetaCPAN modules (which are factually hyperlinked).
If the developers are more inclined towards explanatory text than towards a limited list of hyperlinked modules, perhaps something along the lines of the below might be considered to simply add after the current content, where if such change were made the SEE ALSO section would constitute a single paragraph.
It is also used by L<PDL> (PDL::Minuit and PDL::Slatec), the interfaces implemented, respectively, to the Minuit minimization library from CERN, and to parts of the slatec library, the latter also serving the purpose of showing how to interface PDL to an external library.
Seems reasonable to me. I've made an edit on the tests-improve branch
This issue refers to the F77.pm SEE ALSO section, not the README file.
I would ask the developers to make a F77.pm file decision on the SEE ALSO section.
-
overwrite the SEE ALSO section verbatim as in #7 (comment)
-
leave the SEE ALSO section as is
-
to the unmodified current content of the SEE ALSO section add verbatim the sentence as
in #7 (comment)
Woops. Fixed, I think, but let's not over analyse these minors pieces of text!