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 multi-line returns sections in docs #112

Open
T-Nicholls opened this issue Aug 23, 2019 · 0 comments
Open

Fix multi-line returns sections in docs #112

T-Nicholls opened this issue Aug 23, 2019 · 0 comments

Comments

@T-Nicholls
Copy link
Collaborator

Currently, the formatting of some of our returns sections (those that span multiple lines of code) is messed up on read the docs, for an example look at DataSourceManager.get_fields(). This is a Sphinx Napoleon issue (sphinx-contrib/napoleon#4); however, we can fix it locally one of two ways:

  1. Reduce all our Returns: sections to fit on one line, most do already.
  2. Change out indentation style to that shown as a fix in the above issue, however for consistency we would probably have to update all other sections to that indentation style too.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant