oauthlib / oauthlib/oauthlib

suggestion: oauth1 docs - more consistent and document 'interfaces'

Open
#373 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Contributor Friendly Documentation OAuth1
Dominant language
Python
Stars
3k
Forks
529
PR merge metrics
No merged PRs in 30d

Description

this is mostly targeted at the oauth1 docs. i haven't gotten into oauth2 yet.

there are 2 rather annoying bits:

  1. all the args dealing with tokens use token. it would be a lot better if they used terms like request_token and access_token.
  2. when there are dicts/objects involved, I think it might make more sense to have a package that lists the various 'interfaces' that are expected.

for example, save_request_token in 'request_validator' expects token to be a dictionary that includes at least 3 terms. meanwhile save_verifier expects token to be a string and implements a verifier dict that has several oauth_ prefixed items. while it's great that these are documented very well, the repetition of terms and concepts in difference contexts can be very confusing.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the OAuth1 documentation and the RequestValidator methods named in the issue: save_request_token and save_verifier. Map the documented token arguments and expected dictionary or string interfaces, then check that the resulting documentation uses consistent names and clearly distinguishes each interface.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
authentication, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.