Skip to content

Dart API Reference is impossible to visually scan #1440

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
DartBot opened this issue Feb 1, 2012 · 10 comments
Closed

Dart API Reference is impossible to visually scan #1440

DartBot opened this issue Feb 1, 2012 · 10 comments

Comments

@DartBot
Copy link

DartBot commented Feb 1, 2012

This issue was originally filed by [email protected]


What steps will reproduce the problem?

  1. Open http://api.dartlang.org/html/Element.html
  2. Try to find some kind of class management methods/properties.

What is the expected output? What do you see instead?
EXPECTED: It is possible to visually easily scan the methods and properties defined on this class.
ACTUAL: It is absolutely painful to try to do that.

What version of the product are you using? On what operating system?
N/A.

Please provide any additional information below.
The biggest problems are:

  1. The method/property names don't stand out from return type and so on.
  2. The method/property names are not on the same "column" - you have to scan left and right in order to find it.
  3. The method/property names are too spaced out and there's various (mostly useless, in dart:html) text in-between them.
  4. The spacing between one method and the next varies from nothing to a lot.
  5. The "Constructors" and "Methods" and so on sections are almost not distinguishable.
@dgrove
Copy link
Contributor

dgrove commented Feb 1, 2012

Set owner to @munificent.
Added Area-Site, Triaged labels.

@sethladd
Copy link
Contributor

sethladd commented Jun 1, 2012

Removed Area-Site label.
Added Area-DartDoc label.

@munificent
Copy link
Member

We'll address this when we refresh dartlang.org's overall visual style.


Added this to the Later milestone.

@munificent
Copy link
Member

Removed the owner.

@dgrove
Copy link
Contributor

dgrove commented Oct 18, 2012

to fix in the next generation dartdoc viewer.


cc @jmesserly.
Set owner to @jacob314.

@DartBot
Copy link
Author

DartBot commented Mar 9, 2013

This comment was originally written by [email protected]


Marked this as being blocked by #8857.

@jacob314
Copy link
Member

Set owner to @efortuna.

@efortuna
Copy link
Contributor

efortuna commented Oct 4, 2013

Some of these bugs we may be able to close. I'm just passing them over so that you're aware of them, Alan.


cc @alan-knight.
Removed the owner.

@anders-sandholm
Copy link
Contributor

Added old-dartdoc label.

@alan-knight
Copy link
Contributor

New dartdoc viewer has a table of contents on the right hand side for this.


Added Fixed label.

@DartBot DartBot added this to the Later milestone Feb 12, 2014
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

8 participants