Skip to content

Document embedder SDK packages only when they are in the same path as the main package. #1972

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
wants to merge 1 commit into from

Conversation

isoos
Copy link
Contributor

@isoos isoos commented May 24, 2019

Running dartdoc on Flutter packages generates docs for the SDK libraries too, and pub site wants to exclude them (pub site issue: dart-lang/pub-dev#2108 ). However using --exclude removes the links, e.g. Future is not linked to the official SDK docs page.

Restricting the embedder SDK to the direct subdirectories solves the issue for the Flutter packages, and also keeps the option to generate embedder SDK docs if needed.

@googlebot googlebot added the cla: yes Google CLA check succeeded. label May 24, 2019
@jonasfj jonasfj requested review from devoncarew and keertip May 24, 2019 11:00
@devoncarew
Copy link
Member

@isoos, it looks like there are some travis failures. I think some of that is related to a new version of pedantic. If so, I'll peg to an older version and commit that to master. You'll need to update this branch from master after that.

@keertip for review

@devoncarew
Copy link
Member

@isoos, can you update the body of this PR w/ the issues it'll fix?

@devoncarew
Copy link
Member

The pedantic change has landed in master.

@keertip
Copy link
Collaborator

keertip commented May 24, 2019

@isoos, could you rebase and see if the tests pass?

@isoos
Copy link
Contributor Author

isoos commented May 24, 2019

rebased, force pushed

@mit-mit
Copy link
Member

mit-mit commented Jan 7, 2020

@jcollins-g @isoos is anyone looking at fixing this? I'd love to get dart-lang/pub-dev#2117 resolved.

@jcollins-g
Copy link
Contributor

I am not looking at this.

@mit-mit
Copy link
Member

mit-mit commented Jan 7, 2020

Do we have an alternate way of resolving dart-lang/pub-dev#2117 ?

@isoos
Copy link
Contributor Author

isoos commented Jan 7, 2020

Do we have an alternate way of resolving dart-lang/pub-dev#2117 ?

Note: The package may have changed since last May, but at that time, I tracked the root cause back to the embedder SDK-related code here (and an assumed change in Flutter which was never tracked down when it happened). I have no idea what the embedder SDK-related code is supposed to do or when it is used (or if this is the correct way of resolving the issue), and I can't even say that the PR was the correct way how to address this.

@isoos
Copy link
Contributor Author

isoos commented Apr 16, 2020

This has been fixed elsewhere.

@isoos isoos closed this Apr 16, 2020
@isoos isoos deleted the embedder-sdk branch April 16, 2020 09:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes Google CLA check succeeded.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants