Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Unhide the stageview.open function for documentation #2065

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Unhide the stageview.open function for documentation #2065

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dc6fdda
removing hidden tag open function
sbtron Nov 17, 2023
2fad088
Change files
sbtron Nov 17, 2023
b57df8f
Merge branch 'main' into sbtron/typedocupdate
TrevorJoelHarris Nov 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 7 additions & 0 deletions change/@microsoft-teams-js-58d459f0-1a10-49ee-898f-117799bb4bda.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "none",
"comment": "removing hidden tag open function",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, references to code (like stageView.open) should be surrounded by backticks (`) so that github formats them differently

"packageName": "@microsoft/teams-js",
"email": "sbtron@users.noreply.github.com",
"dependentChangeType": "none"
}
1 change: 0 additions & 1 deletion packages/teams-js/src/public/stageView.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,6 @@ export namespace stageView {
}

/**
* @hidden
* Feature is under development
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

*
* Opens a stage view to display a Teams application
Expand Down