prawn icon indicating copy to clipboard operation
prawn copied to clipboard

add example of a decument method to the manual

Open Juraj-Sulimanovic opened this issue 1 year ago • 2 comments

Issue 1307

The example that is mentioned in the manual is missing. I just added the example mentioned on the issue itself.

Juraj-Sulimanovic avatar Jan 16 '24 09:01 Juraj-Sulimanovic

Thank you for your contribution.

However, I don't think this is a very good addition. Manual describes how the method can be defined in order to get a custom document and here a default one is defined instead. I believe the manual is clear enough on the optionality of the method and its purpose. So if you want to demonstrate that then at least add some options to the document so that it was clear why the method is present in the example.

pointlessone avatar Jan 16 '24 15:01 pointlessone

Thank you for your contribution.

However, I don't think this is a very good addition. Manual describes how the method can be defined in order to get a custom document and here a default one is defined instead. I believe the manual is clear enough on the optionality of the method and its purpose. So if you want to demonstrate that then at least add some options to the document so that it was clear why the method is present in the example.

Thank you for the constructive comment. I added some options in the method. The failing spec is related to a different commit.

Juraj-Sulimanovic avatar Jan 18 '24 09:01 Juraj-Sulimanovic

Thank you for your contribution. This has been merged outside of GitHub.

pointlessone avatar Mar 04 '24 07:03 pointlessone