This project is archived and is in readonly mode.

#353 ✓invalid
UloPe

Documentation: method name order

Reported by UloPe | September 2nd, 2008 @ 07:54 PM | in 1.4.0 (closed)

Currently the method names in the documentation of most (all?) objects are sorted in what appears to be random order.

This is unintuitive and confusing.

Comments and changes to this ticket

  • Jan Kassens

    Jan Kassens September 2nd, 2008 @ 09:57 PM

    • State changed from “new” to “hold”

    currently they are (or should be) in a logical order, because some methods should be one after the other, for example: Element.getFirst and Element.getLast.

    any comments on this one?

  • Christoph Pojer

    Christoph Pojer November 9th, 2010 @ 06:59 PM

    • State changed from “hold” to “invalid”
    • Milestone order changed from “0” to “0”
  • Ulrich Petri

    Ulrich Petri November 9th, 2010 @ 07:20 PM

    Could you maybe clarify why this is "invalid"?
    I have yet to come across another API-Reference (and that's what the docs are at the moment) where the members / methods are listed in any other way then alphabetic.

    This is especially a problem for classes with lots of methods (e.g. Element) and when bringing new developers to mootools.

  • Christoph Pojer

    Christoph Pojer November 9th, 2010 @ 07:28 PM

    • State changed from “invalid” to “open”
    • Milestone changed from 2.0 to 1.3.1
    • Assigned user changed from “Valerio” to “Arian”
    • Milestone order changed from “450” to “0”

    Sorry, I bulk edited all those hundred year old tickets. Maybe Arian will take a look! I do agree though that they should be in logical order, rather than alphabetical. Maybe we can group them logically and then alphabetically.

  • Arian

    Arian November 9th, 2010 @ 09:56 PM

    I sorted them a bit:
    http://pastie.org/private/rjwm2ljvrbnjtix0nw81ow

    Maybe we should add some headings in the method list, like I did in the pastie, so it's not such a long list.

    Some method groups like store, retrieve and eliminate should not be alphabetical, because you would get eliminate, retrieve and store, which doesn't sound very logical.

  • Ulrich Petri

    Ulrich Petri November 9th, 2010 @ 10:17 PM

    The problem even with this grouped approach is that I still have to do a "linear scan" of every item if I'm just looking for one specific method (which is - at least for me - 100% percent of the time)

  • Arian

    Arian November 9th, 2010 @ 10:24 PM

    But if you know the method already, and just want to look up some specific things (like which arguments you can use), so you already know what it is supposed to do, so you know in which group it will be. I think the grouped approach is especially useful for people who are not very familiar with the method names yet.

    The current order is already grouped, but not very optimal, probably because some methods are added or moved. Adding headers would improve the readability even more imo.

  • Christoph Pojer

    Christoph Pojer January 11th, 2011 @ 12:13 AM

    @Arian: anything new on this one?

  • Arian

    Arian January 11th, 2011 @ 12:35 AM

    The current documentation runner doesn't support grouping. Darren is planning to work on something new which I'm sure I'll contribute to, so maybe we could keep this ticket in mind so make a better list of methods.

  • Christoph Pojer

    Christoph Pojer January 11th, 2011 @ 01:00 AM

    • Milestone changed from 1.3.1 to 1.4.0
    • Milestone order changed from “9” to “0”
  • Christoph Pojer

    Christoph Pojer August 13th, 2011 @ 12:46 AM

    Arian - any news on this now that we have the new docs thingy?

  • Arian

    Arian August 13th, 2011 @ 12:48 AM

    • Assigned user changed from “Arian” to “fakedarren”
  • ibolmo

    ibolmo January 19th, 2012 @ 10:02 AM

    • State changed from “open” to “invalid”

    Moved to Github Issues: https://github.com/mootools/mootools-core/issues/2235

    Please use Github Issues, since Lighthouse has been deprecated.

Create your profile

Help contribute to this project by taking a few moments to create your personal profile. Create your profile »

Shared Ticket Bins

Referenced by

Pages