Skip to content

link to identifiers in sdk on api.dartlang.org from third-party package #739

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
maiermic opened this issue Jul 28, 2015 · 8 comments
Closed
Labels
contributions-welcome Contributions welcome to help resolve this (the resolution is expected to be clear from the issue) customer-google3 Issues originating from or important to Angular P1 A high priority bug; for example, a single project is unusable or has many test failures type-enhancement A request for a change that isn't a bug

Comments

@maiermic
Copy link

Support links to identifiers (for example List) of the sdk. Links sould be added to types in (class-, method-, ...) signatures and in doc comments (markup links).

@sethladd sethladd added the type-enhancement A request for a change that isn't a bug label Jul 28, 2015
@sethladd sethladd changed the title link to identifiers of sdk link to identifiers in sdk from third-party package Jul 28, 2015
@chalin
Copy link
Contributor

chalin commented Feb 18, 2017

Any update on this? Could it be triaged and marked with a priority level, say, P1 :)

@kwalrath
Copy link
Contributor

@devoncarew do we still have someone working on dartdoc?

@devoncarew
Copy link
Member

@keertip is working on it, but it's not her main task; contributions are welcome here.

@chalin
Copy link
Contributor

chalin commented Feb 18, 2017

@devoncarew - Thanks for the update. Could we at least assign a priority level to this issue?
And maybe tag it as help wanted too?

@devoncarew devoncarew added customer-google3 Issues originating from or important to Angular contributions-welcome Contributions welcome to help resolve this (the resolution is expected to be clear from the issue) P1 A high priority bug; for example, a single project is unusable or has many test failures labels Feb 18, 2017
@jcollins-g
Copy link
Contributor

Is this a request for external linkage to api.dartlang.org, or a request for auto-include-dependencies to do this?

@kwalrath
Copy link
Contributor

The former, I think.

I believe it's a request for externally generated API doc that uses SDK classes to link to the SDK doc, by default. E.g. if an external package (say, args) has a property that's a Map (say, commands), most people would want to be able to click Map and get to https://api.dartlang.org/stable/dart-core/Map-class.html.

Options might be to (1) not generate those links or (2) link to a particular version of the SDK API docs. These links should probably have different default formatting from links inside the same package.

@jcollins-g
Copy link
Contributor

OK. #1368 addressed the latter, the former is definitely on my radar though. Going to adjust the title of the issue to be more clear.

@jcollins-g jcollins-g changed the title link to identifiers in sdk from third-party package link to identifiers in sdk on api.dartlang.org from third-party package Apr 11, 2017
@jcollins-g
Copy link
Contributor

#1524 should make this much easier. Dartdoc now has some elementary package-boundary awareness that we can use to determine whether alternate hyperlinks should be generated, so it's now just a matter of implementing the generation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contributions-welcome Contributions welcome to help resolve this (the resolution is expected to be clear from the issue) customer-google3 Issues originating from or important to Angular P1 A high priority bug; for example, a single project is unusable or has many test failures type-enhancement A request for a change that isn't a bug
Projects
None yet
Development

No branches or pull requests

6 participants