Skip to content

Prettify docs with rich.pretty.install()

Explanation of changes

Cleans up tutorial and makes use of

    # Make output easier to read
    from rich import pretty
    pretty.install()

To move from:

Screenshot_2021-06-07_at_21.59.30

To:

Screenshot_2021-06-07_at_22.19.43

Motivation of changes

Much more readable output. Teaches the users a nice tip.

Additionally I propose we close !92 (closed) in favor of this approach.

@kel85uk should be a quick review.


Merge checklist

See also merge request guidelines

  • Merge request has been reviewed and approved by a project maintainer.
  • Merge request contains a clear description of the proposed changes and the issue it addresses.
  • Merge request made onto appropriate branch (develop for most MRs).
  • New code is fully tested.
  • New code is documented and docstrings use numpydoc format.
  • Changelog has been updated (when applicable).
  • CI pipelines pass
    • black code-formatting passes (gitlab-ci),
    • test suite passes (gitlab-ci),
    • no degradation in code-coverage (codacy),
    • no (serious) new pylint code quality issues introduced (codacy),
    • documentation builds successfully (CI and readthedocs).
Edited by Kelvin Loh

Merge request reports

Loading