Addon-docs: Track code-level args changes in ArgsTable
#16488
Merged
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
…entation changes. This means things like the `ArgsTable` can keep up to date. NOTE: this does not work if a different story to the the "selected" story is updated in docs mode, which can be visible on the screen. This is a symptom of a larger problem in the way that docs mode works.
Nx Cloud ReportCI ran the following commands for commit db17405. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this branch
Sent with 💌 from NxCloud. |
|
I gotta test out first, but have you tried updating jsdocs and seeing if HMR updated them in controls as well? I know that was a problem before. |
I'm not sure. I think there are a few pieces to that puzzle that might not work. |
shilman
changed the title
ArgsTableArgsTable
shilman
reviewed
Oct 27, 2021
| const { selection } = this.urlStore; | ||
| const { | ||
| selection, | ||
| selection: { storyId }, |
There was a problem hiding this comment.
Can selection ever be nullish? the previous code was run under a try block and the new code isn't.
There was a problem hiding this comment.
Good thought! But no ☝️
shilman
approved these changes
Oct 28, 2021
3 tasks
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.
Issue: #16174
What I did
Emit a
STORY_ARGS_UPDATEDevent whenever the current story's implementation changesThis means things like the
ArgsTablecan keep up to date.NOTE: this does not work if a different story to the the "selected" story is updated in docs mode, which can be visible on the screen. This is a symptom of a larger problem in the way that docs mode works.
How to test
react-tsArgsTable.