TeamBasedInquiryLearning / precalculus

Materials for running a Team-Based Inquiry Learning precalculus course (in active development!)
https://teambasedinquirylearning.github.io/precalculus/
Other
4 stars 0 forks source link

Ensure all activities/tasks have <answer>s #192

Open siwelwerd opened 2 months ago

siwelwerd commented 2 months ago

We created the instructor version midway through writing, so we do not currently have <answer>s for all of the activities.

siwelwerd commented 1 month ago

To list these, run xpath -e '//activity[not(task) and not(answer)]' source/*/*.ptx to find activities with no tasks and no answer, and xpath -e '//task[not(answer)]' source/*/*.ptx to find tasks that don't have an answer.

StevenClontz commented 1 month ago

It'd be great to have a linter that runs in GitHub to check for these things, and have an X show up when they are forgotten. Perhaps if we had one, it'd be in scope for the EditAThon to make this enhancement for LA and Calc too?

siwelwerd commented 1 month ago

I don't know what a linter is, but I can think of a few things that PreTeXt doesn't check for that I'd appreciate our action checking for. The other big one that comes to mind is @xml:ids for certain things (e.g. images; see https://github.com/TeamBasedInquiryLearning/calculus/issues/78)

it'd be in scope for the EditAThon to make this enhancement for LA and Calc too?

Do you mean copy the action over to those books, or to create instructor versions for them which contain <answer>s?

StevenClontz commented 1 month ago

A linter is a tool that checks that certain preferences in a software product are satisfied. So theoretically we could add preferences that images have xml:ids, that tasks have answers, etc.

Do you mean copy the action over to those books, or to create instructor versions for them which contain s?

To create instructor versions with answers, so that our linter won't balk at the lack thereof.