Lukas, I recall you bringing this up in IRC and it sounded like a great ideal. The only roadblock, which is probably minor, would be the normalization steps that receive arbitrary closures. I suppose Jordi's suggestion of documentation properties on nodes could come in handy, so developers could explain what the closure might do (if an explanation is even warranted).
On Sun, Feb 13, 2011 at 4:32 PM, Lukas Kahwe Smith <[email protected]>wrote: > Hi, > > I am throwing this out here in case someone has some spare programming > cycles and wants to help Symfony2 in a huge way. As you might have noticed > the new way to handle merging, adding defaults and normalizing between > formats are Configuration classes: > > https://github.com/fabpot/symfony/blob/master/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php > > First up I think we still need some people to take on some of the Bundles > and migrate them over to this. > > But more importantly I think these classes are a perfect opportunity to > ease documentation. My idea is that there should be some tool to generate > human readable documentation out of these Configuration classes in the reST > format. This documentation would list the defaults and the merging rules. > Potentially even generate some examples (though maybe for that we might need > to ponder if we need to add some comment standard for the Configuration > classes) in different formats. > > This is just an idea, but I think it would be a huge help both for core, > but even more importantly for 3rd party Bundle authors that tend to squander > on documentation. > > regards, > Lukas Kahwe Smith > [email protected] > > > > -- > If you want to report a vulnerability issue on symfony, please send it to > security at symfony-project.com > > You received this message because you are subscribed to the Google > Groups "symfony developers" group. > To post to this group, send email to [email protected] > To unsubscribe from this group, send email to > [email protected] > For more options, visit this group at > http://groups.google.com/group/symfony-devs?hl=en > -- jeremy mikola -- If you want to report a vulnerability issue on symfony, please send it to security at symfony-project.com You received this message because you are subscribed to the Google Groups "symfony developers" group. To post to this group, send email to [email protected] To unsubscribe from this group, send email to [email protected] For more options, visit this group at http://groups.google.com/group/symfony-devs?hl=en
