Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding documentation about voters #236

Open
Nek- opened this issue Jul 4, 2014 · 6 comments
Open

Adding documentation about voters #236

Nek- opened this issue Jul 4, 2014 · 6 comments

Comments

@Nek-
Copy link
Contributor

Nek- commented Jul 4, 2014

@wouterj
Copy link
Collaborator

wouterj commented Aug 28, 2015

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

@dbu
Copy link
Collaborator

dbu commented Aug 28, 2015

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
Copy link
Collaborator

stof commented Aug 28, 2015

We have DI tags

@xDaizu
Copy link

xDaizu commented Dec 17, 2015

@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
Copy link
Collaborator

dbu commented Dec 17, 2015

@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
Copy link

xDaizu commented Dec 17, 2015

@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. :)

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

No branches or pull requests

5 participants