Skip to content

Updated sphinx syntax #231

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 9 commits into from
Sep 18, 2020
Merged

Updated sphinx syntax #231

merged 9 commits into from
Sep 18, 2020

Conversation

BastianZim
Copy link
Contributor

@BastianZim BastianZim commented Sep 17, 2020 •
edited
Loading

As outlined in #230 the documentation style is not consistent. This fixes the style for the OAuth file.

Fixes #227

@codecov
Copy link

codecov bot commented Sep 17, 2020 •
edited
Loading

Codecov Report

Merging #231 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #231   +/-   ##
=======================================
  Coverage   46.98%   46.98%           
=======================================
  Files          32       32           
  Lines       77334    77334           
  Branches     6370     6370           
=======================================
  Hits        36332    36332           
  Misses      40951    40951           
  Partials       51       51
Flag Coverage Δ
#unit 46.98% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
dropbox/oauth.py 55.25% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c41c2c8...33b47e1. Read the comment docs.

@BastianZim BastianZim marked this pull request as draft September 17, 2020 16:47
@greg-db greg-db requested a review from rogebrd September 17, 2020 17:36
@BastianZim
Copy link
Contributor Author

BastianZim commented Sep 17, 2020 •
edited
Loading

Summary: As described in #230 there are different documentation styles in some files which I tried to unify.
Since I couldn't find a guide about which one is preferred I just went with the official one but I can also switch it to :Args: style if that's preferred.

@BastianZim BastianZim marked this pull request as ready for review September 17, 2020 19:38
@rogebrd
Copy link
Contributor

rogebrd commented Sep 18, 2020

Looks good to me, would you mind just linking me to the guide you used?

@BastianZim
Copy link
Contributor Author

Thanks! Of course, it's from Sphinx.

rogebrd
rogebrd approved these changes Sep 18, 2020
View reviewed changes
Copy link
Contributor

@rogebrd rogebrd left a comment

Choose a reason for hiding this comment

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

Really appreciate you going through and fixing these comments!

@BastianZim
Copy link
Contributor Author

Pleasure! Thanks for approving.

@BastianZim
Copy link
Contributor Author

@rogebrd Just to confirm, would you like me to add anything else because this would be ready to merge from my side?

@rogebrd rogebrd merged commit da092ea into dropbox:master Sep 18, 2020
@BastianZim BastianZim deleted the fix-docs branch September 18, 2020 21:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
1 more reviewer

@rogebrd rogebrd rogebrd approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

New line in docs is incorrectly broken in readthedocs
2 participants
@BastianZim @rogebrd