Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation needs to be clearer about consumption #3

Open
kentfredric opened this issue Oct 3, 2015 · 1 comment
Open

Documentation needs to be clearer about consumption #3

kentfredric opened this issue Oct 3, 2015 · 1 comment

Comments

@kentfredric
Copy link

I was talking to somebody today on IRC, who was trying to use autobox and was being confused why none of the code in the synopsis as-is.

I think the synopsis and documentation needs to be more explict in that autobox.pm creates none of the methods, and autobox.pm is explicitly a toolkit for other autoboxing things to use, and that the synopsis is only an example of what could be done once all the relevant subs are installed in SCALAR::length() etc, and that unless somebody is explicitly authoring a autoboxing module, that they should probably be consuming an existing autoboxer, like autobox::Core or MooseX::Autobox

@chocolateboy
Copy link
Owner

I totally agree. But I'm not gonna change the documentation because I can't think of a better way to summarize what autobox enables. If you (or anyone else) can, please submit a PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants