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

docs: add documentation to passport methods #143

Merged
merged 2 commits into from
Oct 16, 2024
Merged

docs: add documentation to passport methods #143

merged 2 commits into from
Oct 16, 2024

Conversation

ImmutableJeffrey
Copy link
Contributor

@ImmutableJeffrey ImmutableJeffrey commented Oct 15, 2024

Summary

Add documentation to passport methods

  • Prefix your PR title with feat: , fix: , chore: , docs: , refactor: or test: .
  • Sample blueprints are updated with new SDK changes
  • Updated public documentation with new SDK changes (Immutable X and Immutable zkEVM)
  • Replied to GitHub issues

Source/Immutable/Public/Immutable/ImmutablePassport.h Outdated Show resolved Hide resolved
Source/Immutable/Public/Immutable/ImmutablePassport.h Outdated Show resolved Hide resolved
Source/Immutable/Public/Immutable/ImmutablePassport.h Outdated Show resolved Hide resolved
Source/Immutable/Public/Immutable/ImmutableDataTypes.h Outdated Show resolved Hide resolved
Source/Immutable/Public/Immutable/ImmutablePassport.h Outdated Show resolved Hide resolved
Source/Immutable/Public/Immutable/ImmutablePassport.h Outdated Show resolved Hide resolved
Source/Immutable/Public/Immutable/ImmutablePassport.h Outdated Show resolved Hide resolved
Source/Immutable/Public/Immutable/ImmutablePassport.h Outdated Show resolved Hide resolved
Source/Immutable/Public/Immutable/ImmutablePassport.h Outdated Show resolved Hide resolved
Copy link
Contributor Author

@ImmutableJeffrey ImmutableJeffrey left a comment

Choose a reason for hiding this comment

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

Approving suggestions

@YermekG YermekG merged commit 039edd3 into main Oct 16, 2024
10 checks passed
@YermekG YermekG deleted the docs/dx-2515 branch October 16, 2024 02:59
* Logs the user into Passport via device code auth and sets up the Immutable X provider.
*
* This will open the user's default browser and take them through Passport login.
* @param IsConnectImx If true, the "re-connect" method is used to authenticate into Passport with Immutable X.
Copy link
Collaborator

Choose a reason for hiding this comment

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

This one is quite confusing because it if this then that, then an if becomes another if else. Maybe split it into Immutable X: xxx
Immutable zkEVM: xxx

Copy link
Contributor

Choose a reason for hiding this comment

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

This is a part of the game bridge code. I tried to state what happens inside the game bridge when you reconnect.

Copy link
Contributor

Choose a reason for hiding this comment

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

I am not sure how else it should be stated

ImmutableJeffrey added a commit that referenced this pull request Oct 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants