How about a comment at the top pointing to the page? Another option I really like is autogenerated links to the relevant pages or anchor tags within pages. Those would not get out of date.
On Sun, Nov 22, 2009 at 2:37 PM, Marijn Huizendveld <[email protected]> wrote: > Hi, > > I used to love the commented section but now that we have the > reference guide (which is very great since it also gives the possible > configuration options) I'm all for removing it. > > Kindest regards, > > - Marijn > > > On Nov 22, 2009, at 8:34 PM, Fabian Lange wrote: > >> I think the reason for removing them is to avoid duplication. in fact >> the end of line comment is never as good as the ref guide. And for >> most settings the comment is anyway not that interesting. >> But frankly, i do not know the reason why fabien removed them >> Fabian >> >> 2009/11/22 Łukasz Wojciechowski <[email protected]>: >>> I also noticed that they are gone and I also think that It would be >>> better If we had them back. >>> >>> -- >>> Best regards >>> Łukasz Wojciechowski >>> >>> New Generation Software >>> +48 602 214 629 >>> http://www.ngsoft.pl >>> >>> >>> >>> 2009/11/22 ever.zet <[email protected]>: >>>> Fully agree with Crafty_Shadow. Old comments style in settings.yml >>>> was very helpful! >>>> >>>> 22.11.2009, в 13:39, Crafty_Shadow написал(а): >>>> >>>>> As of symfony 1.3, the configuration files no longer contain a >>>>> reference to the possible configuration options in the form of >>>>> commented out lines of the defaults and their explanation. I am >>>>> well >>>>> aware of the symfony reference book, however I strongly believe the >>>>> old approach was better. >>>>> >>>>> For starters, with the old approach I didn't need to open a >>>>> browser, >>>>> find the book, search for that particular config file and finally >>>>> find >>>>> the option I need. This is very time-taking and frustrating >>>>> compared >>>>> to the work-flow with 1.2. What, are we supposed to remember every >>>>> configuration option by heart now? >>>>> >>>>> And what about the people who just start with symfony, or are >>>>> joining >>>>> a project already in progress? How are they supposed to figure this >>>>> out? Read the definitive guide, find the reference to the reference >>>>> book (pun intended) and all that when all the info they needed >>>>> could've been left in the very same configuration file? >>>>> >>>>> What was the reason for removing this information? It can't be to >>>>> speed up the parsing as these files are cached anyways. >>>>> >>>>> -- >>>>> >>>>> 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= >>>>> . >>>>> >>>>> >>>> >>>> -- >>>> >>>> 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= >>>> . >>>> >>>> >>>> >>>> >>> >>> -- >>> >>> 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= >>> . >>> >>> >>> >> >> -- >> >> 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= >> . >> >> > > -- > > 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=. > > > -- Tom Boutell P'unk Avenue 215 755 1330 punkave.com window.punkave.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=.
