Skip to content

Improved docs #180

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

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

Improved docs #180

wants to merge 3 commits into from

Conversation

Genarito
Copy link

Hi! First of all, thank you for this library. It is my first time using it, and thanks to the IDE I discovered that there was an image parameter in the provisioning_uri method. Also, looking at the source code I discovered that it consisted of a URL.

In this PR, the image parameter is defined explicitly in all the methods involved and added some documentation for it. I also added some missing documentation for methods such as byte_secret or provisioning_uri (from the TOTP class).

I also considered it was good to document that the digits parameter in the Steam class is discarded and hardcoded to 10. So I added this clarification and changed the default value to make it more intuitive to the naked eye.

Finally, I standardized a little bit, adding the missing dots in sentences, I documented a :return and corrected a typo.

I remain pending if you consider that other changes should be made. Greetings!

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.

1 participant