Skip Menu |

This queue is for tickets about the Set-IntSpan CPAN distribution.

Report information
The Basics
Id: 79634
Status: rejected
Priority: 0/
Queue: Set-IntSpan

People
Owner: SWMCD [...] cpan.org
Requestors: SILASMONK [...] cpan.org
Cc:
AdminCc:

Bug Information
Severity: Important
Broken in: (no value)
Fixed in: (no value)



Subject: Problems with documentation
Firstly the documentation encourages the use of "indirect object notation" which is frowned upon and very hard to read for developers used to more modern styles. Secondly there is something odd about the format of the pod, because when converted to a man page it is littered with quotes in odd places. For example: "empty" $set Returns true iff $set is empty. "finite" $set Returns true iff $set is finite. "neg_inf" $set Returns true iff $set contains {x | x<n} for some n. "pos_inf" $set Returns true iff $set contains {x | x>n} for some n.
The method names are marked up in the POD like C<empty>, which is conventional for literal code. The quotes in the man page are generated by pod2man. From man pod2man -q quotes, --quotes=quotes Sets the quote marks used to surround C<> text to quotes. If quotes is a single character, it is used as both the left and right quote; if quotes is two characters, the first character is used as the left quote and the second as the right quoted; and if quotes is four characters, the first two are used as the left quote and the second two as the right quote. quotes may also be set to the special value "none", in which case no quote marks are added around C<> text (but the font is still changed for troff output).
Sorry, indirect syntax stays in the POD. For a responsible opposing viewpoint, see http://world.std.com/~swmcd/steven/perl/pm/flex.html#indirect