Skip to content
This repository has been archived by the owner on May 24, 2018. It is now read-only.

Add PhpDoc-comments to code examples in the documentation #478

Open
localheinz opened this issue Nov 13, 2012 · 2 comments
Open

Add PhpDoc-comments to code examples in the documentation #478

localheinz opened this issue Nov 13, 2012 · 2 comments

Comments

@localheinz
Copy link
Member

Currently, in the code examples in the documentation, PhpDoc-comments for class methods are missing. While I believe adding them doesn't do any harm, I'm convinced that these would greatly improve the documentation, as well as convey good craftsmanship.

@localheinz
Copy link
Member Author

Also, most of the detailed explanations of code snippets could be gotten rid of and instead, these explanations could be fit into comments within the code.

Have a look at this:

Example of explanations that should rather be comments in the code examples

@GeeH
Copy link
Contributor

GeeH commented Mar 20, 2013

Hi @localheinz, it's a very valid point, would be delighted to receive a PR with these modifications :)

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants