[api-extractor] Generate documentation for setters without getters #3396
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
zelliott
requested review from
D4N14L,
apostolisms,
iclanton,
octogonz and
sachinjoseph
as code owners
zelliott
changed the title
zelliott
commented
May 5, 2022
octogonz
reviewed
May 14, 2022
octogonz
approved these changes
May 14, 2022
|
Released with API Extractor 7.24.0 |
Qjuh
pushed a commit
to discordjs/rushstack
that referenced
this pull request
Nov 7, 2023
[api-extractor] Generate documentation for setters without getters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Instead of ignoring setters entirely, this PR changes API Extractor to generate documentation for a setter if and only if there is no associated getter. If there is an associated getter, the setter is ignored. Note that API Extractor still has the
ae-missing-getterwarning for teams that want to discourage setters without getters.In the future, perhaps an
isWriteonlybit can be added to these nodes, similar to #3265.Details
N/A
How it was tested
Added a relevant scenario to the api-documenter-test build test, ran
rush rebuild, manually verified that the generated artifacts were correct.