Fix many library sidebars, and search #3865
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
srawlins
added a commit
to srawlins/dartdoc
that referenced
this pull request
Sep 3, 2024
An unrelated fix, dart-lang#3865, revealed that the wildcard-variables experiment was not actually enabled in tests; the SDK constraint used in test packages needs to be '^3.6.0'. With that fix, there are some questions about how much dartdoc should be doing to keep wildcards "non-binding" and how much the analyzer should be doing. So that is raised in dart-lang#3769 (comment).
1 task
srawlins
force-pushed
the
fix-exported-libs
branch
from
3b59e42 to
546405b
Compare
|
The bots are going wild... failures but no logs |
scheglov
approved these changes
Sep 3, 2024
The library sidebars on container (e.g. Class), top-level variable, top-level function, and typedefs were totally busted, as a result of d629e1e. Fixes dart-lang#3859 and fixes dart-lang#3861. The fix is to allow a Library's `canonicalModelElement` to be it's canonical library, instead of `null`. This involves adding a few checks for "am I calculating something for a Library?" and moving some "is this library considered public" logic out of `Element.hasPrivateName` and into `ModelElement.isPublic`. That corrects the issue of an exported Class's (for example) enclosing element's URI, for the search results. Once all of that is fixed, we also correct the `aboveSidebarPath` implementation for a few elements, to point to the _canonical_ library's sidebar path. This fix highlights an issue with wildcard-variables, so one test is newly marked as failing.
srawlins
force-pushed
the
fix-exported-libs
branch
from
546405b to
ca608e7
Compare
srawlins
added a commit
that referenced
this pull request
Sep 4, 2024
An unrelated fix, #3865, revealed that the wildcard-variables experiment was not actually enabled in tests; the SDK constraint used in test packages needs to be '^3.6.0'. With that fix, there are some questions about how much dartdoc should be doing to keep wildcards "non-binding" and how much the analyzer should be doing. So that is raised in #3769 (comment).
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.
The library sidebars on container (e.g. Class), top-level variable, top-level function, and typedefs were totally busted, as a result of d629e1e.
Fixes #3859 and fixes #3861.
The fix is to allow a Library's
canonicalModelElementto be it's canonical library, instead ofnull. This involves adding a few checks for "am I calculating something for a Library?" and moving some "is this library considered public" logic out ofElement.hasPrivateNameand intoModelElement.isPublic. That corrects the issue of an exported Class's (for example) enclosing element's URI, for the search results.Once all of that is fixed, we also correct the
aboveSidebarPathimplementation for a few elements, to point to the canonical library's sidebar path.This fix highlights an issue with wildcard-variables, so one test is newly marked as failing.
Contribution guidelines:
dart format.Note that many Dart repos have a weekly cadence for reviewing PRs - please allow for some latency before initial review feedback.