This forum is in READ-ONLY mode.
You can look around, but if you want to ask a new question, please use Stack Overflow.

Code Snippets directly in API docs, like on php.net

Requests for new symfony features.

Code Snippets directly in API docs, like on php.net

by ffx » Fri Nov 12, 2010 5:21 pm

Could you add the possibility for the user to add and view comments to the api doc pages as we can see on php.net?

IMO the documentation of Symfony badly lacks in example code. It's too complicated and time consuming to do research each time, looking into google, looking into the forum, looking into code snippet area.

Also the documentation for a lot of parameters is very poor. For example the widget parameters and attributes doesn't seem to be documented at all in the api pages.

Why not adding a code snippet / comment functionality directly to the api pages? Let the user fill the missing information. This would be a great feature and I think it is no real effort to implement.

Thanks for thinking about it.

Best regards.
ffx
Junior Member
 
Posts: 8
Joined: Mon Oct 18, 2010 2:11 pm