build: api-docs can display incorrect module for entry-point #16470
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
In some cases, an entry-point can export a deprecated NgModule. Currently
if that module is exported after all previous modules, it will show up in the docs
as recommended import. e.g. `import {ScrollDispatchModule} from '@angular/cdk/scrolling';`
This is causing confusion as the non-deprecated module should be used for rendering
the recommended import. This commit ensures that non-deprecated modules are
prioritized over deprecated modules and that specific modules can be explicitly
selected as primary module for an entry-point.
Fixes angular#16353.
devversion
added
P2
googlebot
added
the
cla: yes
jelbourn
approved these changes
Jul 8, 2019
| /** Whether the given document is annotated with the "@docs-primary-module" jsdoc tag. */ | ||
| export function isPrimaryModuleDoc(doc: any) { | ||
| return (doc.tags && doc.tags.tags || []) | ||
| .some((tag: any) => tag.tagName === 'docs-primary-module'); |
There was a problem hiding this comment.
Maybe in another PR, but we should have some docs about our custom JsDoc tags
There was a problem hiding this comment.
Yeah totally. I had the same thought when creating that PR and created #16469 for tracking.
|
For reference: This also fixed that the |
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
In some cases, an entry-point can export a deprecated NgModule. Currently
if that module is exported after all previous modules, it will show up in the docs
as recommended import. e.g.
import {ScrollDispatchModule} from '@angular/cdk/scrolling';This is causing confusion as the non-deprecated module should be used for rendering
the recommended import. This commit ensures that non-deprecated modules are
prioritized over deprecated modules and that specific modules can be explicitly
selected as primary module for an entry-point.
Fixes #16353.