Skip to content

Change the order of groups on dartdoc pages #1323

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
Hixie opened this issue Jan 12, 2017 · 14 comments
Closed

Change the order of groups on dartdoc pages #1323

Hixie opened this issue Jan 12, 2017 · 14 comments
Assignees
Labels
customer-flutter Issues originating from important to Flutter P1 A high priority bug; for example, a single project is unusable or has many test failures

Comments

@Hixie
Copy link
Contributor

Hixie commented Jan 12, 2017

The order right now is a bit weird (especially that typedefs come so early on the library page).

Here are the suggested new orders:

  • Top-level page: flutter, dart core, flutter_markdown, flutter_test, flutter_driver.
  • Library pages: classes, constants, properties, functions, enums, typedefs, exceptions.
  • Enum pages: constants, properties, methods, operators.
  • Class pages: constructors, properties, methods, operators, static methods, constants.

cc @sethladd

@Hixie Hixie added customer-flutter Issues originating from important to Flutter P2 A bug or feature request we're likely to work on labels Jan 12, 2017
@sethladd
Copy link
Contributor

This list is approved. Go forth and make it awesome.

@sethladd
Copy link
Contributor

cc @astashov if you're looking for one P2, this one is an easy one :)

@Hixie Hixie added P1 A high priority bug; for example, a single project is unusable or has many test failures and removed P2 A bug or feature request we're likely to work on labels Feb 13, 2017
@sethladd sethladd added P0 A serious issue requiring immediate resolution and removed P1 A high priority bug; for example, a single project is unusable or has many test failures labels Mar 30, 2017
@devoncarew devoncarew added P1 A high priority bug; for example, a single project is unusable or has many test failures and removed P0 A serious issue requiring immediate resolution labels Mar 30, 2017
@jcollins-g
Copy link
Contributor

This has two parts influencing it: the script that constructs the "package" that dartdoc actually documents for flutter, and the dartdoc internal category sorting. Starting work on the latter, first.

@jcollins-g jcollins-g self-assigned this Apr 11, 2017
@jcollins-g
Copy link
Contributor

@Hixie / @sethladd : it would be easier to do this automatically with flutter_driver before flutter_markdown and flutter_test. Would that be acceptable? I'll have to add a flag to specify ordering otherwise.

@Hixie
Copy link
Contributor Author

Hixie commented Apr 11, 2017

It's probably fine, but it's definitely suboptimal. We ideally want flutter_test (unit tests) above flutter_driver (integration tests, more complicated), and ideally want flutter_markdown (a flutter runtime package) before the test packages.

Might be worth just giving us explicit control (maybe default to the order on the command line, say), that way you never have to worry about it again. :-)

@jcollins-g
Copy link
Contributor

Sounds good. I'll still improve the automatic categorizing but give you control on the command line to override it.

@Hixie
Copy link
Contributor Author

Hixie commented Apr 11, 2017

Also any improvement is an improvement, we're happy to take things bit by bit if that's more tractable than going all the way to space in one step. :-)

@jcollins-g
Copy link
Contributor

It's alright, this isn't nearly as painful as #1334 turned out to be :-)

@jcollins-g
Copy link
Contributor

Static properties weren't mentioned under classes in the order above, so moving them to before static methods.

@jcollins-g
Copy link
Contributor

Can't fix this without touching the code for #1225, so fixing that too.

@jcollins-g
Copy link
Contributor

Done, cleaned up and has tests, but stuck behind #1368. Some examples below from Flutter.

Top level, with new --category-order flag set to:
"flutter,Dart Core,flutter_markdown,flutter_test,flutter_driver":

screenshot from 2017-04-12 11 11 21

Library:
screenshot from 2017-04-12 12 10 25

Class:
screenshot from 2017-04-12 12 23 57

Enum:
screenshot from 2017-04-12 12 11 19

@Hixie
Copy link
Contributor Author

Hixie commented Apr 12, 2017

That is gorgeous.

@jcollins-g jcollins-g added status-blocked Blocked from making progress by another (referenced) issue and removed status-blocked Blocked from making progress by another (referenced) issue labels Apr 13, 2017
@Hixie
Copy link
Contributor Author

Hixie commented May 2, 2017

It looks like the order of groups on library, enum, and class pages hasn't changed. Should I file a separate bug to track those?

@jcollins-g
Copy link
Contributor

This is fixed in head as screenshots indicate, but until #1390 lands to correct the many broken links from doc references introduced in #1368 it's not really usable yet.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
customer-flutter Issues originating from important to Flutter P1 A high priority bug; for example, a single project is unusable or has many test failures
Projects
None yet
Development

No branches or pull requests

4 participants