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.

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

Deprecated pages.NavigateCrossDomain and updated typedocs #2017

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

Conversation

vikramtha
Copy link
Contributor

For more information about how to contribute to this repo, visit this page.

Description

Summarize the changes, including the goals and reasons for this change. Be sure to call out any technical or behavior changes that reviewers should be aware of.

If this Pull Request should close/resolve any issues when merged, use the special syntax for that here.

Main changes in the PR:

  1. Deprecated pages.NavigateCrossDomain
  2. Updated comments for the v1 NavigateCrossDomain

Validation

Validation performed:

n/a

Unit Tests added:

Unit tests are required for all changes. If no unit tests were added as part of this change, please explain why they aren't necessary.

No, only typedoc changes

End-to-end tests added:

na/

Additional Requirements

Change file added:

Ensure the change file meets the formatting requirements.

Yes

ydogandjiev
ydogandjiev previously approved these changes Nov 1, 2023
@@ -46,7 +46,7 @@ export function navigateToTab(tabInstance: TabInstance, onComplete?: onCompleteH

/**
* @deprecated
* As of 2.0.0, please use {@link pages.navigateCrossDomain pages.navigateCrossDomain(url: string): Promise\<void\>} instead.
* As of 2.0.0, this API is no longer needed. Please remove any calls to it.
Copy link
Contributor

@AE-MS AE-MS Nov 1, 2023

Choose a reason for hiding this comment

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

As of 2.0.0, this API is no longer needed. Please remove any calls to it.

What should developers who read this do instead?

Can you delete the text below (or updated it to somehow reflect that it's not necessary to know this anymore?) since developers shouldn't use it anymore?

Copy link
Contributor

@AE-MS AE-MS left a comment

Choose a reason for hiding this comment

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

🕐

…4.json

Co-authored-by: Trevor Harris <trharris@microsoft.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants