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

Update authentication method docs #324

Merged
merged 1 commit into from May 6, 2024
Merged

Conversation

marcfrederick
Copy link
Member

@marcfrederick marcfrederick commented Feb 9, 2024

Attempt to resolve #322, by clarifying the authentication section of the documentation.

@AdamWill
Copy link
Member

I kinda preferred how the existing file has OAuth first. We really want to encourage people to use OAuth for what's probably the most common use case (connecting to wikimedia wikis). In my experience you should always put the thing people are usually meant to do first, then other stuff comes afterwards.

@marcfrederick
Copy link
Member Author

In my experience you should always put the thing people are usually meant to do first, then other stuff comes afterwards.

Good point, I've switched the sections back to the original order.

@marcfrederick marcfrederick changed the title docs: #322 Update authentication method docs Update authentication method docs Feb 10, 2024
@AdamWill
Copy link
Member

Should we also document clientlogin()?

@AdamWill
Copy link
Member

AdamWill commented May 6, 2024

Well, this is clearly an improvement anyway, so let's go with it. I guess I'll write a follow-up to document clientlogin.

@AdamWill AdamWill merged commit 5d4ca88 into master May 6, 2024
7 checks passed
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.

Update authentication documentation page
2 participants