Unhide the stageview.open function for documentation #2065
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
erikadoyle
reviewed
Nov 28, 2023
| @@ -70,7 +70,6 @@ export namespace stageView { | |||
| } | |||
|
|
|||
| /** | |||
| * @hidden | |||
| * Feature is under development | |||
There was a problem hiding this comment.
Should this ("Feature is under development") be removed? The @beta tag would imply that in the public documentation (and no other public beta features have this note)
TrevorJoelHarris
requested changes
Nov 28, 2023
| @@ -0,0 +1,7 @@ | |||
| { | |||
| "type": "none", | |||
| "comment": "removing hidden tag open function", | |||
There was a problem hiding this comment.
Suggested change
| "comment": "removing hidden tag open function", | |
| "comment": "Added documentation for `stageView.open`", |
Changefiles should be written in past tense and should describe what effect the change would have that would matter to external developers (because these comments get added to the monthly patch notes)
There was a problem hiding this comment.
Also, references to code (like stageView.open) should be surrounded by backticks (`) so that github formats them differently
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.
For more information about how to contribute to this repo, visit this page.
Description
Removing the hidden tag from the open function so that it can be documented correctly.
Main changes in the PR:
Validation
Validation performed:
None. Doc update only
Unit Tests added:
None doc updates only
End-to-end tests added:
No
Additional Requirements
Change file added:
Yes
Related PRs:
N/A
Next/remaining steps: