Skip to content

Improve clarity of CI errors for example docstring formatting #1570

Closed
@pushfoo

Description

@pushfoo

Enhancement request:

What should be added/changed?

The output of the example docstring tests should be clearer. At the moment, it looks like this:

FAILED tests/unit/test_example_docstrings.py::test_docstrings - AssertionError: python -m arcade.examples.bloom_defender not in arcade.examples.bloom_defender docs...

Specifically, we should look into adding at least two things:

  1. Explain more clearly when a docstring is missing entirely
  2. Explain when a docstring has an incorrect run command + what it should be

I am not sure how to include this in CI at the moment. Outputting the expected run command on failure may be easier.

What would it help with?

Two regular contributors have been confused by the output of the CI docstring checks. Improving legibility here would improve our development speed.

Metadata

Metadata

Assignees

No one assigned

    Labels

    testsEverything related to testing

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions