Document setModifierManager and modifier capabilities - #21652
Open
NullVoxPopuli wants to merge 2 commits into
Open
NullVoxPopuli wants to merge 2 commits into
NullVoxPopuli wants to merge 2 commits into
Conversation
Adds API docs for the public `setModifierManager` and `capabilities` exports of `@ember/modifier`, and declares `@ember/modifier` as a public docs module so they show up on api.emberjs.com. Closes emberjs#18967 Closes emberjs#20273 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_013JirFwqPVyTTFj5zPbonSh
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_013JirFwqPVyTTFj5zPbonSh
This branch has not been deployed
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
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.
Requested by NullVoxPopuli · project thread
Before:
setModifierManagerandcapabilitiesfrom@ember/modifierare public (RFC 373, RFC 652) but have no API docs, and@ember/modifierdoes not appear as a module on api.emberjs.com.After: both are documented under a new public
@ember/modifierdocs module, matching howsetHelperManagerandcapabilitiesare documented in@ember/helper. The docs cover the manager interface, when each hook runs, thedisableAutoTrackingcapability, and a small function-modifier manager example.How: YUIDoc blocks in
packages/@ember/modifier/index.ts, plus the two new entries intests/docs/expected.cjs.pnpm lint:docspasses.Closes #18967
Closes #20273
🤖 Generated with Claude Code
https://claude.ai/code/session_013JirFwqPVyTTFj5zPbonSh