search

Klortho / Physics-Unit

Perl Physics::Unit module
http://search.cpan.org/perldoc?Physics::Unit
Do What The F*ck You Want To Public License
8 stars 3 forks source link

Remerge .pod files into .pm #23

Closed Klortho closed 12 years ago

Klortho commented 12 years ago

Doh!

While working on the documentation, I got the mistaken impression that I could split the POD documentation out of the .pm modules. So I split Unit.pm's docs into Unit.pod. It worked fine when I did "build html" on my working version, but now the main document pages are not showing up on search.cpan.org or others.

jberger commented 12 years ago

Hmmmm, well I think my first thought would just to be to put it back in. If this was to help get the dynamic creation of docs for the Units, dont worry I'll get that one. For the meantime, I suggest releasing and 0.51 with the docs visible.

On Mon, May 14, 2012 at 12:25 AM, Chris Maloney < reply@reply.github.com

wrote:

Doh!

While working on the documentation, I got the mistaken impression that I could split the POD documentation out of the .pm modules. So I split Unit.pm's docs into Unit.pod. It worked fine when I did "build html" on my working version, but now the main document pages are not showing up on search.cpan.org or others.

Reply to this email directly or view it on GitHub: https://github.com/Klortho/Physics-Unit/issues/23

Klortho commented 12 years ago

No, it wasn't about dynamic creation of docs, it was just my thinking that it would make the module marginally more efficient if the Perl parser didn't have to load such a large file each time. But I guess the "END" takes care of that, really.

I'm making 0.5.1 -- is that okay? Was "0.51" a typo, or were you really suggesting that?

jberger commented 12 years ago

I really don't think the size of these files is a problem for the parser. There are some HUGE modules with internal documentation.

As to the numbering, there are some really confusing issues to this. You can use the version module to see how they compare

$ perl -E 'use version; say version->parse("0.5.1")->numify'
0.005001

versus

$ perl -E 'use version; say version->parse("0.51")->numify'
0.510

The problem with the 2 decimal format is that it assumes 3 digits between decimals, so what you are thinking of as 0.5.1 should be 0.500.1 which is silly. Again I always look to http://www.dagolden.com/index.php/369/version-numbers-should-be-boring/ to remember the best practices for this. The biggest is once a module uses single decimal or double decimal, it should always do so.