Skip to content

Fix Sphinx error for oauth1 fetch_token documentation#462

Merged
jtroussard merged 1 commit intomasterfrom
sphinx-o1-docs
Nov 21, 2021
Merged

Fix Sphinx error for oauth1 fetch_token documentation#462
jtroussard merged 1 commit intomasterfrom
sphinx-o1-docs

Conversation

@JonathanHuot
Copy link
Contributor

@JonathanHuot JonathanHuot commented Nov 11, 2021 •
edited
Loading

jtroussard
jtroussard requested changes Nov 11, 2021
View reviewed changes
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 •
edited
Loading

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

jtroussard
jtroussard approved these changes Nov 21, 2021
View reviewed changes
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

Reviewers

@jtroussard jtroussard jtroussard approved these changes

Assignees

No one assigned

Labels

docs

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@JonathanHuot @jtroussard