[Prototype-core] Re: Style Issues in new API Docs
On Sep 13, 2009, at 5:24 PM, T.J. Crowder wrote: > > This is already fixed in the latest trunk and so will be fixed quite > soon the next time the docs are re-generated from the source. In fact, I re-generated the docs earlier today. Cheers, Andrew --~--~-~--~~~---~--~~ You received this message because you are subscribed to the Google Groups "Prototype: Core" group. To post to this group, send email to prototype-core@googlegroups.com To unsubscribe from this group, send email to prototype-core-unsubscr...@googlegroups.com For more options, visit this group at http://groups.google.com/group/prototype-core?hl=en -~--~~~~--~~--~--~---
[Prototype-core] Re: Style Issues in new API Docs
Hi T.J., Thanks for the quick response. I've filed a ticket for class methods positioning at https://prototype.lighthouseapp.com/projects/8889/tickets/11-method-list-after-class-description-instead-of-under-class-header. -Ryan On Sep 13, 6:24 pm, "T.J. Crowder" wrote: > Hi Ryan, > > Thanks for that. > > > * Class methods no longer immediately listed under class header, and > > are difficult to distinguish while skimming. > > Interesting point; would you open a ticket in Lighthouse about it?[1] > > > * The list of methods/examples all runs together visually. > > We're planning to switch (back) to having a summary page where each > method gets its own page. I think that will address this. > > > * "Examples" headers are bold, black, and larger while method headers > > are gray and smaller, making the "example" header stand out over the > > method names. > > This is already fixed in the latest trunk and so will be fixed quite > soon the next time the docs are re-generated from the source. > > [1]https://prototype.lighthouseapp.com/projects/8889-pdoc/ > > Thanks again, > -- > T.J. Crowder > tj / crowder software / comwww.crowdersoftware.com > > On Sep 13, 9:58 pm, Ryan Baumann wrote: > > > > > I've just gotten a chance to look at the new PDoc-generated > > documentation, and I think making a few stylistic changes would really > > improve the usability of the new docs: > > > * Class methods no longer immediately listed under class header, and > > are difficult to distinguish while skimming. A simple fix for this > > might be to just put them immediately under the class header, where > > the style may not be as big of an issue because of its location. > > * The list of methods/examples all runs together visually. Indenting > > the content of each method after the header would improve things here > > by establishing a visual hierarchy, I think. > > * "Examples" headers are bold, black, and larger while method headers > > are gray and smaller, making the "example" header stand out over the > > method names. I think you could just switch this so that method names > > are in an while the "example" header is in an , which would > > reverse the styling. > > > Especially with this going forward as the "default" template for PDoc, > > and Prototype being a high-profile user of it, making the style as > > readable as possible should promote adoption of what is shaping up to > > be a great documentation tool. > > > -Ryan --~--~-~--~~~---~--~~ You received this message because you are subscribed to the Google Groups "Prototype: Core" group. To post to this group, send email to prototype-core@googlegroups.com To unsubscribe from this group, send email to prototype-core-unsubscr...@googlegroups.com For more options, visit this group at http://groups.google.com/group/prototype-core?hl=en -~--~~~~--~~--~--~---
[Prototype-core] Re: Style Issues in new API Docs
Hi Ryan, Thanks for that. > * Class methods no longer immediately listed under class header, and > are difficult to distinguish while skimming. Interesting point; would you open a ticket in Lighthouse about it?[1] > * The list of methods/examples all runs together visually. We're planning to switch (back) to having a summary page where each method gets its own page. I think that will address this. > * "Examples" headers are bold, black, and larger while method headers > are gray and smaller, making the "example" header stand out over the > method names. This is already fixed in the latest trunk and so will be fixed quite soon the next time the docs are re-generated from the source. [1] https://prototype.lighthouseapp.com/projects/8889-pdoc/ Thanks again, -- T.J. Crowder tj / crowder software / com www.crowdersoftware.com On Sep 13, 9:58 pm, Ryan Baumann wrote: > I've just gotten a chance to look at the new PDoc-generated > documentation, and I think making a few stylistic changes would really > improve the usability of the new docs: > > * Class methods no longer immediately listed under class header, and > are difficult to distinguish while skimming. A simple fix for this > might be to just put them immediately under the class header, where > the style may not be as big of an issue because of its location. > * The list of methods/examples all runs together visually. Indenting > the content of each method after the header would improve things here > by establishing a visual hierarchy, I think. > * "Examples" headers are bold, black, and larger while method headers > are gray and smaller, making the "example" header stand out over the > method names. I think you could just switch this so that method names > are in an while the "example" header is in an , which would > reverse the styling. > > Especially with this going forward as the "default" template for PDoc, > and Prototype being a high-profile user of it, making the style as > readable as possible should promote adoption of what is shaping up to > be a great documentation tool. > > -Ryan --~--~-~--~~~---~--~~ You received this message because you are subscribed to the Google Groups "Prototype: Core" group. To post to this group, send email to prototype-core@googlegroups.com To unsubscribe from this group, send email to prototype-core-unsubscr...@googlegroups.com For more options, visit this group at http://groups.google.com/group/prototype-core?hl=en -~--~~~~--~~--~--~---
