Skip to content

Fix multi-line returns sections in docs #112

@T-Nicholls

Description

@T-Nicholls

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions