Skip Menu |
 

This queue is for tickets about the Every CPAN distribution.

Report information
The Basics
Id: 38304
Status: open
Priority: 0/
Queue: Every

People
Owner: Nobody in particular
Requestors: IKEGAMI [...] cpan.org
Cc:
AdminCc:

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



Subject: Documentation improvements
Download (untitled) / with headers
text/plain 753b
Three issues. 1. "every" is documented to have a parameter named "@id", but the function and format of that parameter is undocumented. 2. It's clear how often "every" returns true, but there's no documentation covering when it will return true for the first time. On the first pass? Or after period passes? pass every(3) ---- -------- 1 T or F? 2 F or F? 3 F or T? 4 T or F? 5 F or F? 6 F or T? 3. I foresee the following pitfall being common Given every(3)||every(4) pass expected actual ---- -------- ------ 1 F||F=F F||F=F 2 F||F=F F||F=F 3 T||F=T T =T 4 F||T=T F||F=F 5 F||F=F F||T=T 6 T||F=T T =T 7 F||F=F F||F=F 8 F||T=T F||F=F Perhaps that should visited in the documentation.
Download (untitled) / with headers
text/plain 1012b
On Thu Aug 07 17:08:31 2008, ikegami wrote: Show quoted text
> Three issues. > > 1. "every" is documented to have a parameter named "@id", but the > function and format of that parameter is undocumented. > > 2. It's clear how often "every" returns true, but there's no > documentation covering when it will return true for the first time. On > the first pass? Or after period passes? > > pass every(3) > ---- -------- > 1 T or F? > 2 F or F? > 3 F or T? > 4 T or F? > 5 F or F? > 6 F or T? > > 3. I foresee the following pitfall being common > > Given every(3)||every(4) > > pass expected actual > ---- -------- ------ > 1 F||F=F F||F=F > 2 F||F=F F||F=F > 3 T||F=T T =T > 4 F||T=T F||F=F > 5 F||F=F F||T=T > 6 T||F=T T =T > 7 F||F=F F||F=F > 8 F||T=T F||F=F > > Perhaps that should visited in the documentation.
I addressed these in the documentation. Please see if it's better now. As with the other issue you raised, sorry for missing this ticket. Ted


This service is sponsored and maintained by Best Practical Solutions and runs on Perl.org infrastructure.

Please report any issues with rt.cpan.org to rt-cpan-admin@bestpractical.com.