I infer from your response that, as far as you know, the answer to the question I asked is that there is not an explanation of Time::Piece::_wday in the module's documentation. In fact, none of the module's methods are explained in the documentation.
What is unclear?
The difference between Time::Piece::_wday and Time::Piece::day_of_week, for example.
Here's what Dave Rolsky wrote about Time::Piece in his landmark 2003 Perl.com article titled The Many Dates and Times of Perl:
Written and maintained by Matt Sergeant, this module is based on an interface designed by Larry Wall. It provides a convenient object API for datetimes, though the API is a bit confusing. For example, $time->mon returns the month number (1-12) while $time->month returns the abbreviated name of the month.
IMHO, because the API is confusing, the methods should properly be explicitly explained in the module's documentation—even those methods that, to an experienced computer programmer, seem plainly obvious from their names alone.
| [reply] [d/l] [select] |
IMHO, because the API is confusing, the methods should properly be explicitly explained in the module's documentation—even those methods that, to an experienced computer programmer, seem plainly obvious from their names alone.
Make a request via perlbug. Increase the likelihood of your request being applied by submitting a patch.
| [reply] |
For example, $time->mon returns the month number (1-12) while $time->m
+onth returns the abbreviated name of the month.
Less is more: $t->mon # 1 = January
$t->_mon # 0 = January
$t->monname # Feb
$t->month # same as $t->monname
$t->fullmonth # February
I much prefer the above documentation over renaming mon() and month() to month_number_starting_with_January_at_index_zero() and abbreviated_month_name(), or verbose 'explanations' cluttering up the place. Perhaps day_of_week() could say "same as $t->_wday()", but it seems pretty obvious to me that that is the case.
I infer from your response that, as far as you know, the answer to the question I asked is that there is not an explanation of Time::Piece::_wday in the module's documentation.
You infer incorrectly. IMHO, the amount of explanation already given is sufficient, and very little, if anything, should be added. | [reply] [d/l] [select] |
| [reply] [d/l] [select] |