| Subject: | Documentation Issues |
I was just trying to help out with a question about this module on
StackOverflow.
http://stackoverflow.com/questions/11563923/why-is-my-perl-code-causing-
my-string-to-receive-array0xc99b3c-instead-of-the
I noticed that it was the documentation that was confusing the user and
that it would be simple to improve it.
Your examples of the stem() method talk about it returning an anonymous
array. I'm sure that's try, but someone calling you method doesn't care
whether or not the array is anonymous. They do care, however, that the
method returns a _reference_ to an array. And you don't make that
explicit anywhere in the documentation.
I also notice that you mention called stem() as a class method and show
that as:
Lingua::Stem::stem(@words)
That is not calling it as a class method. That is calling it as a
function. Calling it as a class method would be:
Lingua::Stem->stem(@words)
Misusing OO terms inaccurately like that can be confusing to users.
Thanks...