Skip to content

Parsons problem files repeat details #3

Open
@nmstoker

Description

@nmstoker

I may be missing some sensible reason, but it seems like the Parsons problem files repeat various details and thus aren't "DRY".

There's a risk that the tests explained in the problem description in the .yaml file end up differing from those included in the .py header.

I wonder if it might be feasible to simply do away completely with the .py header - after all, it isn't even a complete stand-alone Python script - and then simply rely on the details in the .yaml file.

I see there are slight (intentional) differences in the problem description from the .yaml file and the .py docstrings anyway, and the ability to add text/formatting you wouldn't likely put into a docstring seems useful, so those details seem like they should remain in the .yaml file along with the doctest text they contain and then it's simply a matter of using that for feeding the doctest process.

Hope that makes sense and that I haven't completely misinterpreted how the code is intended to be 🙂 Happy to have a go at this with an initial PR to show how this could be achieved, if you like?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions