Yet more docs work #275
Merged
Yet more docs work #275
Conversation
This file contains 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
Re-exported Pinia methods on the WWTAwareComponent weren't getting documented correctly. So, bite the bullet and move all of the docs to be associated with `engineStore()` rather than WWTAwareComponent. This is better in the long run anyway, since Vue-land is pushing people towards the Composition API. This causes some new warnings because *some* of the engineStore docs end up getting attached to the WWTAwareComponent, and the internal links to renamed properties break in that context, but ... whatever.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I realized that the Pinia store methods weren't actually getting documented — while docstrings in
wwtaware.tsworked for properties, they weren't coming through for methods. It is probably better to center the docs on the engineStore anyway, since Vue is pushing people towards the composition API, so here we bite the bullet and shift everything over. It is now looking like the docs are all there.