Skip to content

Allow updating manual examples automatically #375

Description

@fingolfin

An important feature for Test and TestDirectory are their optional arguments rewriteToFile which allows updating .tst files to carry the "new" outputs by GAP. This is useful if e.g. a printing function changed and now a lots of test files need to be adapted to it. It can also be quite useful for creating new .tst files: just put into the inputs, prefix them with gap>, and run the above to get the outputs filled in, formatted in just the right way (of course you need to double check that the outputs make sense and are correct).

In GAPDoc, there is a similar option to update tests in the XML files: It has a function RunExamples which takes an option changeSources that is otherwise similar to rewriteToFile.

It would be useful if we had a similar feature. For inputs that are GAPDoc XML files, we could perhaps piggy back on RunExamples. But ideally we'd also allow updating AutoDoc code comments and .autodoc files.

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions