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 in oauth_session1 to match existing pattern #478

Closed jtroussard closed 2 years ago

jtroussard commented 2 years ago

Notice

Accidentally closed last PR - trying to work out why coverage decreases by -0.0 percent when running coveralls with python version 3.7>

Original Description

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 74e2f9ec47c039520d6aaf83ca3fb007ac1c70b8 on update_docs into 05a25a96522dc64c25224a4862f2342a6978e80d on master.

jtroussard commented 2 years ago

Only difference I can find between 3.8> coveralls checks and the earlier versions of python is the calculation of relevant lines. Created issue in the coverallsapp repo hoping for some support. Anyone else see something I am missing?

JonathanHuot commented 2 years ago

Merging as we know coverage is OK.