[DOC] Add documentation for RFC 0821 items#20272
Merged
chriskrycho merged 1 commit intomasterfrom Nov 22, 2022
Merged
Conversation
- Introduce or relocate documentation for all the `@ember/owner` types. - Make sure all documented owner and routing types correctly express their type hierarchies in the docs so linking and inheritance flags both work correctly. - Move the documentation for `RouteInfo` and `Transition` to their new modules. Additionally, eliminate the now-empty `lib` module for the `Transition` type since it *only* existed to provide documentation. - Update coverage expectation to include the new items.
10 tasks
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.
@ember/ownertypes.RouteInfoandTransitionto their new modules. Additionally, eliminate the now-emptylibmodule for theTransitiontype since it only existed to provide documentation.A note: this, extremely annoyingly, uses
@classannotations for a great many types which are not classes. Our current API documentation infrastructure has no idea what types are (reasonably enough: it was built for a pure JS world!), so things likeinterfaceor especiallytype FullName = ...have… hacks… to make them show up correctly in the docs. However, they do work correctly in the docs; I ran against the API Docs app for most of the dev cycle.