Beefy Boxes and Bandwidth Generously Provided by pair Networks
XP is just a number

Re^3: CPAN distribution naming recommendations

by no_slogan (Deacon)
on Jun 04, 2017 at 14:33 UTC ( #1192123=note: print w/replies, xml ) Need Help??

in reply to Re^2: CPAN distribution naming recommendations
in thread CPAN distribution naming recommendations

Geo::Compass::Variation works for me, though I suspect that term is more common in the nautical world.

One technical comment on your code is that it makes more sense for _calculate to return the X,Y,Z magnetic field components and leave the atan2 fiddling to mag_dec and mag_inc. (Maybe mag_dec should have an alias, mag_var.) Since someone might find an interesting use for that information, you might rename _calculate to mag_field and document it as a part of the interface.

BTW, the technical report has some test data you could use in your module tests.

  • Comment on Re^3: CPAN distribution naming recommendations

Replies are listed 'Best First'.
Re^4: CPAN distribution naming recommendations
by stevieb (Canon) on Jun 04, 2017 at 14:44 UTC

    Thanks no_slogan!

    I'll be out most of the day, so I'll take a look at your recommendations either tonight or tomorrow and get them implemented.

      Just one more thought. The namespace Geo::Compass:: highlights the module's practical application, while Geo::Magnetic:: leans toward its theoretical nature (modeling the geomagnetic field). Either one seems fine to me. I leave the choice in your hands.

        I have released Geo::Compass::Variation. If it isn't available yet, it will be shortly. Thanks to everyone who provided their input and thoughts into the naming, and the reasons/details surrounding the suggestions.

        I made the following changes:

        • added an alias of mag_var() to mag_dec()
        • renamed _calculate() to mag_field()
        • mag_field() now returns the $X, $Y, $Z information instead of the calculated information
        • mag_dec() and mag_inc() now perform their own calculations on the data returned by mag_field()

        I have not yet incorporated the test data into the test suite, but that'll come soon enough.

        Oops, forgot to log in there.

Log In?

What's my password?
Create A New User
Domain Nodelet?
Node Status?
node history
Node Type: note [id://1192123]
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others making s'mores by the fire in the courtyard of the Monastery: (1)
As of 2023-05-31 02:52 GMT
Find Nodes?
    Voting Booth?

    No recent polls found