-
Notifications
You must be signed in to change notification settings - Fork 118
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
library references should be URIs, not the library name #1658
Comments
Yeah, that's a problem. We should remove all usages of library names in dartdoc. I think this is likely the main thing blocking dart-lang/sdk#32738; most other pieces of the ecosystem either don't care about the library name at all or don't use it for important things. |
So I went through googleapis and got rid of pointless Guess what? We should really fix this! |
FYI: all of those |
Here's an example of one of the source files: That's currently inferring |
Whoa. Mega cringe. |
What if the import URIs were available via mouseover and on the library pages themselves, and we started warning for duplicate library names in the same package? No matter what compressed form we choose for the left sidebar there are going to be cases where the user will want to override that -- and there already is a way to do that, the |
We also prefer that part files refer to the library they are part of by URI and not library name. |
Fixes #542 Until dart-lang/dartdoc#1658 is fixed
Fixes #542 Until dart-lang/dartdoc#1658 is fixed
Good plan. How about we also save a few characters of space and strip the
+1 |
I guess I'm conflating two issues, but adding ".dart" solves #1000 as well. I could use, for example, |
I wonder if very long library paths aren't the exception rather than the rule, and we couldn't just get away with truncation + having the full path in a tooltip? It would save giving the left nav more space - which would eat into other screen real estate - or making it horizontally scrollable, which I think would overall hinder usability. |
Yeah a tooltip is a good idea too. Probably better UX. |
I think that could work. It would also be OK to retain the |
Since EVERY import will end in Maybe include it in the tooltip? |
See
https://pub.dartlang.org/documentation/angular/5.0.0-alpha+9/index.html
Doesn't help
Should be
These are the actual files I'd import.
...and more painfully
https://pub.dartlang.org/documentation/angular_components/0.9.0-alpha+9/index.html
In this case, there are many libraries named
module
– no way to tell them apart.Better to have long URIs than ambiguous names...
The text was updated successfully, but these errors were encountered: