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

Add documentation for ActionCodeURL #3933

Merged
merged 1 commit into from Oct 13, 2020
Merged

Conversation

avolkovi
Copy link
Contributor

No description provided.

@changeset-bot
Copy link

changeset-bot bot commented Oct 13, 2020

⚠️ No Changeset found

Latest commit: 4f2b450

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@@ -4,6 +4,8 @@

## ActionCodeURL.operation property

The action performed by the email action link. It returns from one of the types from
Copy link
Contributor Author

Choose a reason for hiding this comment

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

looks like the @link got truncated

Copy link
Contributor

Choose a reason for hiding this comment

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

ah that answers it

@@ -4,6 +4,8 @@

## ActionCodeURL.operation property

The action performed by the email action link. It returns from one of the types from [ActionCodeInfo](./auth-types.actioncodeinfo.md)
Copy link
Contributor

@sam-gc sam-gc Oct 13, 2020

Choose a reason for hiding this comment

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

does {@link ActionCodeInfo} work?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

looks like it works in the auth-types docs but not the auth docs, probably will self resolve once I add documentation for ActionCodeInfo in both

@@ -45,11 +49,20 @@ const MODE_TO_OPERATION_MAP: { [key: string]: externs.Operation } = {

/**
* Maps the mode string in action code URL to Action Code Info operation.
*
* @param mode
* @internal
Copy link
Contributor

Choose a reason for hiding this comment

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

You don't need to do this right? Since these are not exported?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think you're right, doing it for consistency here anyway, no promises I'll do it everywhere

@google-oss-bot
Copy link
Contributor

Binary Size Report

Affected SDKs

No changes between base commit (d4966cf) and head commit (458bd6e).

Test Logs

@google-oss-bot
Copy link
Contributor

Size Analysis Report

Affected Products

No changes between base commit (d4966cf) and head commit (458bd6e).

Test Logs

@avolkovi avolkovi merged commit 8c0f1e2 into master Oct 13, 2020
@avolkovi avolkovi deleted the avolkovi/avolkovi/auth-exp-docs branch October 13, 2020 21:29
@firebase firebase locked and limited conversation to collaborators Nov 13, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants