Skip to content

Test examples embeded in the README and docs/ Markdown documents #136

@llucax

Description

@llucax

What's needed?

The documentation in docs/ usually also host some code examples, so we should make sure they stay up to date too.

Proposed solution

Use Sybil or other tool to extract the examples, and then run the linters, checkers, etc.

Use cases

No response

Alternatives and workarounds

No response

Additional context

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    part:cookiecutterAffects the generation of projects using cookiecutterpart:docsAffects the documentationpart:testsAffects the unit, integration and performance (benchmarks) teststype:enhancementNew feature or enhancement visitble to users

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions