search

requests / requests-oauthlib

OAuthlib support for Python-Requests!
https://requests-oauthlib.readthedocs.org/
ISC License
1.71k stars 421 forks source link

updates docs to follow method doc patterns #476

Closed jtroussard closed 2 years ago

jtroussard commented 2 years ago

Related to discussion on #473 #443 #442

Looks like all the uncertainty stems from a slight break for the existing documentation convention/pattern. Method documentation for, fetch_request_token in requests_oauthlib/oauth1_session.py added the double asterisk to the optional argument in the function description. The existing pattern is to add them for the signature and leave them off in the description. Before the doc string was flagged as a raw string, this was generating a warning for Invalid Escape Sequence.

Removing the raw string flag and the asterisks as it breaks the pattern already set.

coveralls commented 2 years ago

Coverage Status

Coverage remained the same at 90.239% when pulling beeb5f19579730291083d70a819c2e88215e6ded on update_docs into 05a25a96522dc64c25224a4862f2342a6978e80d on master.