in reply to Looking for feedback on my documentation

Reading the Type::Tiny manual without a background in Antlers, rodent or bovine modules - it fails to convey the underlying purpose.

A small code sample of usage without the animal references would certainly clarify that.

Thanks for all your efforts!

                "From there to here, from here to there, funny things are everywhere." -- Dr. Seuss

  • Comment on Re: Looking for feedback on my documentation

Replies are listed 'Best First'.
Re^2: Looking for feedback on my documentation
by tobyink (Canon) on Nov 25, 2019 at 20:26 UTC

    Hmmm... were you reading Type::Tiny::Manual? Because I feel like your comment probably applies more to the Type::Tiny class documentation which is more internal and less good as a starting point. There is a pointer from Type::Tiny's pod to the manual, but it might need to be made more prominent.

      If you could throw in a statement from your blog article
      saying something like "Type::Tiny is a drop-in replacement for Params::Validate."

      That would help a lot.

      Even more helpful would be : synopsis -style code for : how to re-write your "sub hash_add()" parameter validator using Type::Tiny (without antlers/rodents etc).

                      "From there to here, from here to there, funny things are everywhere." -- Dr. Seuss