search

worthmine / Text-vCard-Precisely

Read, Write or Edit vCard 3.0 or 4.0 with perl
https://metacpan.org/pod/Text::vCard::Precisely
Other
3 stars 3 forks source link

GD->new( ... some param ... )->plot()->png(); #21

Closed szabgab closed 4 years ago

szabgab commented 4 years ago

In the synopsis there is a code snipped

GD->new( ... some param ... )->plot()->png();

It would be nicer if the "some param" was replace by something that could work out of the box. (or out of the copy-paste)

worthmine commented 4 years ago

Thank you for suggesting! I'll try that after fixing #20

worthmine commented 4 years ago

probably I did what you said.

You mean that synopsis should be a code that can run when pasted, don't you?

szabgab commented 4 years ago

I am not 100% sure in this, but I think that having a copy-paste-able synopsis would be a good idea.

I opened a discussion about this. You might be interested to read the opinion of others as well. https://www.reddit.com/r/perl/comments/jbht86/should_the_synopsis_include_working_code_or_is/

worthmine commented 4 years ago

I really appreciate that you made a topic in reddit.

And every opinion in there is interesting.

thank you everything