docs: remove duplicated documentation from classes #408
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
The documentation for the Signal, Computed, and Effect classes was
duplicated from the top-level functions. This commit removes the
duplicated documentation and uses the {@macro} tag to reference the
documentation from the top-level functions.
This makes the code cleaner and easier to maintain, as the
documentation will only need to be updated in one place.
|
The reason I did this was because it was not showing up when I extended the signal vs invoked the constructor directly. Maybe my duplication is no longer needed! |
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.
The documentation for the Signal, Computed, and Effect classes was duplicated from the top-level functions. This commit removes the duplicated documentation and uses the {@macro} tag to reference the documentation from the top-level functions.
This makes the code cleaner and easier to maintain, as the documentation will only need to be updated in one place.