metasarah
09-05-2003, 10:43 AM
In considering a change in the format of the documentation, Antun made a most excellent suggestion that we ask you, who most use the documentation, what you think. Please vote for what you like best and add comments to this thread if you have more detailed feedback.
Currently the docs are formatted like this:
... long descriptive text ...
Attributes
Inherited Attributes (from all super classes in alphabetical order)
Methods
Inherited Methods (from all super classes in alphabetical order)
Alternative:
... long descriptive text ...
Attributes
Methods
Inherited Attributes & Methods
...from immediate super class...
...from next ancestor...
... etc...
Almost all the classes that we currently ship with the product extend either node or view, so it isn't a dramatic change; however, we are building a new set of components that have a few layers of class hierarchy. It seems odd that the node and view attributes might be displayed above the attributes of the immediate super class, just because they happen to start with a letter that is earlier in the alphabet. Also It has always frustrated me that the methods of a class are listed far below the inherited attributes of a distant ancestor.
I will post a poll. Please let me know what you think.
Sarah Allen
Laszlo Systems
Currently the docs are formatted like this:
... long descriptive text ...
Attributes
Inherited Attributes (from all super classes in alphabetical order)
Methods
Inherited Methods (from all super classes in alphabetical order)
Alternative:
... long descriptive text ...
Attributes
Methods
Inherited Attributes & Methods
...from immediate super class...
...from next ancestor...
... etc...
Almost all the classes that we currently ship with the product extend either node or view, so it isn't a dramatic change; however, we are building a new set of components that have a few layers of class hierarchy. It seems odd that the node and view attributes might be displayed above the attributes of the immediate super class, just because they happen to start with a letter that is earlier in the alphabet. Also It has always frustrated me that the methods of a class are listed far below the inherited attributes of a distant ancestor.
I will post a poll. Please let me know what you think.
Sarah Allen
Laszlo Systems