Add a SYNOPSIS section to the doc

p5pclub / ref-util

Ref::Util - Utility functions for checking references

6 stars 11 forks source link

Closed neilb closed 7 years ago

neilb commented 7 years ago

I'm really used to seeing a SYNOPSIS section at the head of documentation on CPAN.

Would you be open to a pull request adding a brief SYNOPSIS, right after the NAME section?

It doesn't need to cover all functions, just enough to show the general idea.

Cheers, Neil

xsawyerx commented 7 years ago

Of course!

arc commented 7 years ago

@neilb There's now a brief synopsis, visible at https://metacpan.org/pod/release/ARC/Ref-Util-0.202/lib/Ref/Util.pm — feel free to supply a PR and/or reopen this issue if you'd like it to be extended.