build: some public API docs missing descriptions #22482
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
crisbeto
added
P2
google-cla
bot
added
the
cla: yes
Fixes that some inherited class members didn't have descriptions in the generated docs. The problem seems to be that we were using the `description` field, whereas the text was in the `content` field. I don't have the context behind why we were using `description`, but the field doesn't exist in Dgeni's typings and `content` seems to work in all the cases I tried.
crisbeto
force-pushed
the
22128/api-docs-missing-description
branch
from
a09f4af to
0bc86d0
Compare
devversion
approved these changes
Apr 16, 2021
wagnermaciel
pushed a commit
that referenced
this pull request
Apr 19, 2021
Fixes that some inherited class members didn't have descriptions in the generated docs. The problem seems to be that we were using the `description` field, whereas the text was in the `content` field. I don't have the context behind why we were using `description`, but the field doesn't exist in Dgeni's typings and `content` seems to work in all the cases I tried. (cherry picked from commit c2d5b7c)
wagnermaciel
pushed a commit
that referenced
this pull request
Apr 19, 2021
Fixes that some inherited class members didn't have descriptions in the generated docs. The problem seems to be that we were using the `description` field, whereas the text was in the `content` field. I don't have the context behind why we were using `description`, but the field doesn't exist in Dgeni's typings and `content` seems to work in all the cases I tried. (cherry picked from commit c2d5b7c)
|
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.
Fixes that some inherited class members didn't have descriptions in the generated docs. The problem seems to be that we were using the
descriptionfield, whereas the text was in thecontentfield. I don't have the context behind why we were usingdescription, but the field doesn't exist in Dgeni's typings andcontentseems to work in all the cases I tried.