DiamondLightSource / DiamondLightSource/pytac

Fix multi-line returns sections in docs

Open
#112 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
7
Forks
5
PR merge metrics
No merged PRs in 30d

Description

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 (https://github.com/sphinx-contrib/napoleon/issues/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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.