Deemphasize reexported symbols [#1158] #1319
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
astashov
force-pushed
the
dedup-model-elements
branch
from
48e8ca5 to
c9d11d6
Compare
@Hixie noticed, that when a library exports another library, but both libraries are being docced together, the result is that each class that is exported by both libraries is listed twice. We should still list classes and other symbols in the libraries that reexport them (since they still part of public API of those libs), but we only gonna show "canonical" symbols in Search, and also we won't create duplicate HTML pages for reexported symbols. We define the reexported symbols in the following way: 1. A defines Foo. 2. Foo doesn't appear in the docs for A because A is a private library, i.e., in lib/src/../a.dart 3. B exports Foo from A. 4. Foo appears in the docs for B. 5. C exports Foo from B. 6. Foo appears in the docs for C. So, Foo of lib C shouldn't have its own page and also shouldn't appear in Search, because Foo was exported from B and B already has docs. All links to Foo from HTML docs of C should point to the Foo of B. To solve that, we build directed "export graph", where we track what libs export what libs. Then, to find the "canonical" lib, we go up the graph until we find first documented lib - that's going to be the canonical one. Then, we filter out non-canonical libs when building the search index, and also use canonical lib in `.href` getters, this way ensuring we always link to symbols in canonical libs and don't create HTML files for symbols from non-canonical libs. Testing: Unit tests, also built test docs (`testing/test_package_docs`), made sure we don't create files for non-canonical stuff (i.e. we create `fake/Cool` files, but not `ex/Cool`). Also, built Flutter docs, ensured we don't create `material/BoxDecoration`, `rendering/BoxDecoration` and `widgets/BoxDecoration`, and only create `painting/BoxDecoration` files, and all the links point to `painting/BoxDecoration`.
astashov
force-pushed
the
dedup-model-elements
branch
from
c9d11d6 to
00abeb1
Compare
keertip
reviewed
Jan 9, 2017
| @@ -0,0 +1,54 @@ | |||
| import 'package:analyzer/dart/element/element.dart'; | |||
|
|
|||
There was a problem hiding this comment.
Please add comments to methods to explain functionality.
|
@keertip PTAL |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@Hixie noticed, that when a library exports another library, but both
libraries are being docced together, the result is that each class that
is exported by both libraries is listed twice.
We should still list classes and other symbols in the libraries that
reexport them (since they still part of public API of those libs), but
we only gonna show "canonical" symbols in Search, and also we won't
create duplicate HTML pages for reexported symbols.
We define the reexported symbols in the following way:
i.e., in lib/src/../a.dart
So, Foo of lib C shouldn't have its own page and also shouldn't appear
in Search, because Foo was exported from B and B already has docs. All
links to Foo from HTML docs of C should point to the Foo of B.
To solve that, we build directed "export graph", where we track what
libs export what libs. Then, to find the "canonical" lib, we go up the
graph until we find first documented lib - that's going to be the
canonical one.
Then, we filter out non-canonical libs when building the search index,
and also use canonical lib in
.hrefgetters, this way ensuring wealways link to symbols in canonical libs and don't create HTML files for
symbols from non-canonical libs.
Testing: Unit tests, also built test docs (
testing/test_package_docs),made sure we don't create files for non-canonical stuff (i.e. we create
fake/Coolfiles, but notex/Cool). Also, built Flutter docs, ensuredwe don't create
material/BoxDecoration,rendering/BoxDecorationandwidgets/BoxDecoration, and only createpainting/BoxDecorationfiles,and all the links point to
painting/BoxDecoration.Fixes #1158