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

Fix Sphinx error for oauth1 fetch_token documentation #462

Merged
merged 1 commit into from Nov 21, 2021

Conversation

JonathanHuot
Copy link
Contributor

@JonathanHuot JonathanHuot commented Nov 11, 2021

Copy link
Contributor

@jtroussard jtroussard left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry. Help me understand the fix? Is this just whitespace formatting?

@JonathanHuot
Copy link
Contributor Author

JonathanHuot commented Nov 11, 2021

Exactly. Since the code is part of a list of params, it cannot have the same indent, else the list is considered as closed, and the parameters below (here it is :returns:) are considered as part of text block).

DocString:

 :param realm: A list of realms to request access to.
 :param \*\*request_kwargs: Optional arguments passed to ''post''
 function in ''requests.Session''
 :returns: The response in dict format. 

Results in:

image

And if we indent the param description like below:

 :param realm: A list of realms to request access to.
 :param \*\*request_kwargs: Optional arguments passed to ''post''
     function in ''requests.Session''
 :returns: The response in dict format. 

It becomes correctly formatted:

image

Copy link
Contributor

@jtroussard jtroussard left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@jtroussard jtroussard merged commit 5abc6f0 into master Nov 21, 2021
@JonathanHuot JonathanHuot deleted the sphinx-o1-docs branch February 25, 2024 21:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants