Skip to content

Feature request: validate sample code in documentation #78

@Vectornaut

Description

@Vectornaut

Feature request

Some documentation errors (for example, issue #77) can be caught by validating sample code. Three possible levels of validation are:

  • Compile the sample code and check for errors and warnings.
  • Run the sample code and check for panics.
  • Use assertions in the sample code to validate behavior.

I've put in checkboxes to indicate which levels Rwf supports so far.

Implementation ideas

I don't think MkDocs has built-in validation tools like rustdoc does, but the mkdocs-code-validator plug-in might work.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions