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 details for client login final step #358

Merged
merged 1 commit into from
Sep 18, 2024

Conversation

lucab
Copy link
Contributor

@lucab lucab commented Aug 19, 2024

This tweaks the documentation on the main module, in order to add some details on the outcome of the client login final step. In particular, it clarifies the result of ClientLogin::finish() both on success and on errors and it adds some intra-crate links to the relevant structures and fields.

@facebook-github-bot
Copy link

Hi @lucab!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks!

@lucab
Copy link
Contributor Author

lucab commented Aug 19, 2024

@kevinlewi thanks for maintaining this library!
I was recently learning about the protocol and after reading the crate docs I was left with some minor questions about the client-side login finish step. I hope this small PR will make it easier for other newcomers like me to navigate through the docs and the login flow.

This tweaks the documentation on the main module, in order to
add some details on the outcome of the client login final step.
In particular, it clarifies the result of `ClientLogin::finish()`
both on success and on errors and it adds some intra-crate links
to the relevant structures and fields.
@kevinlewi kevinlewi merged commit a21678e into facebook:main Sep 18, 2024
57 checks passed
@lucab lucab deleted the ups/doc-client-login-finish branch September 19, 2024 06:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants