Skip to content

TST: run doctest only in a single environment (with a single GEOS version) ? #317

@jorisvandenbossche

Description

@jorisvandenbossche

The doctest regularly give problems in failing doctests across different CI builds. This can generally be solved by either adding a normalize call, or by skipping (# doctest: +SKIP) some parts, or some other workaround.

I would propose to run the doctests only in a single build (eg with the latest released packages on conda-forge), making it easier to get them passing. Arguments:

  • The doctests' purpose is to ensure the documentation is correct, not as an actual test of the functionality (for that we have the other tests). So for this reason, it's not necessarily needed to run them on all CI builds IMO
  • The workarounds to deal with varying behaviour across versions IMO only adds clutter to the docstring, while the main purpose of the docstring is to give a clear, nice example.

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