search

KnpLabs / KnpMenuBundle

Object Oriented menus for your Symfony project.
http://knplabs.com
MIT License
1.4k stars 204 forks source link

Adding documentation about voters #236

Open Nek- opened 10 years ago

Nek- commented 10 years ago
wouterj commented 9 years ago

This is now documented in the library, I don't think we have to document it in the bundle?

dbu commented 9 years ago

i think the bundle documentation should mention and link it in some place (maybe list the features of the library in the bundle introduction?). and do we have DI tags for the voters? if so we should document them here.

stof commented 9 years ago

We have DI tags

xDaizu commented 8 years ago

@dbu +1

They're not documented, though. And I'm not seting a foot inside the /vendor/ folder to dig it out myself! Nothing good ever comes from meddling there!

PS: @wouterJ how to do configure stuff on a library doesn't always match the "symfony way". There's often a better way specific to the bundle. That should be documented here, in the bundle. It's not that you can't do it the other way, but it is usually better(more mantainable/painless) to stick to what the developers have in mind, so it won't break in the next minor version or edge cases or worse,you inadvertedly try to "reinvent the wheel's menu" when there's already some hidden magic that could do the job for you.

dbu commented 8 years ago

@xDaizu i am not sure if anybody currently maintaining this bundle is the person who wrote that part of the code. we all dig into things and figure out stuff. open source is not only about consuming code for free, but also about everybody helping and contributing back. i am sure good things come from looking into /vendor/ and understand what your project is based on, at the least you will learn a lot. don't be afraid of breaking stuff, you will get feedback on pull requests.

xDaizu commented 8 years ago

@dbu I know, I know, it was mainly a joke. It should be documented, though. It will make the life of newcomers like me way easier. But I intend to keep poking (both the code and the community). If people more savvy than me doesn't document it, be it a matter of time or priorities, rest assured, I'll eventually do it myself. :)