requests-oauthlib icon indicating copy to clipboard operation
requests-oauthlib copied to clipboard

Mentions of "URI" should be "URL"

Open shazow opened this issue 10 years ago • 6 comments

The acronym uri is used all over the place in code and documentation, where it should be url. Also url is used in a bunch of places too, where it is already correct.

This is a semantic nitpick, and probably not worth breaking backwards compatibility over. But worth keeping in mind in case you ever end up doing a big refactor and see an opportunity to clean this up. :)

Feel free to close this bug if it doesn't make sense to pursue at this time.

shazow avatar Sep 28 '13 20:09 shazow

+1

sigmavirus24 avatar Sep 29 '13 00:09 sigmavirus24

This is a good idea! However, it will not be fixed in the next version of requests-oauthlib because I want 0.3.4 to make people's lives as easy as possible. =)

Lukasa avatar Sep 29 '13 11:09 Lukasa

Think the only place this would break would be the redirect_uri param and if we want to be careful we could always add redirect_url as a param and raise a deprecation warning when people pass in redirect_uri.

ib-lundgren avatar Oct 01 '13 07:10 ib-lundgren

@ib-lundgren Not a bad idea: we should also raise a new issue to remind us to get rid of it eventually. =)

Lukasa avatar Oct 01 '13 08:10 Lukasa

@Lukasa @ib-lundgren As a newcomer, I would like to work upon this issue. Can I ?

KVGarg avatar Mar 04 '19 16:03 KVGarg

a) I agree that a uniform use of one of uri & url is desirable; but b) I would advocate uri over url

Why b)?

  • redirect_uri is commonly used. AWS, Google, Auth0 will report redirect_uri mismatch errors
    • it may be confusing to set redirect_url and get a redirect_uri error.
    • if we assume we should use redirect_uri here all others should follow uri convention
  • the underlying oauthlib uses the term uri
  • a url is a uri, but a uri is not a url

tomdottom avatar Apr 09 '19 17:04 tomdottom