Starting a checklist of additional items we might want to address. I'll edit here as I find more things

More in-depth autograder integration example. E.g. many instructors will want to show all the feedback and score everything at once for gradescope (the full resolver) edit the documentation to do the full
Instructor control script for score usage. The example uses +10% as a string, but we might want to demonstrate this. It's talked about in the Developers Feedback function section, but we might want to include it in the quick start, examples, or teacher reference. The "Intuitive" path doesn't give you any information, which is Teacher Reference ->score (under feedback functions), which then leads to blank documentation
resolvers aren't really addressed in the documentation very well for someone who wants a quick start, e.g. we document the simple resolver, but full I think might be a popular one (as that's what many instructors are probably used to, which I think is dumping all the feedback), and then I think the third major one is the sectional resolver.
Probably want to fill in the blank documentation here so that instructors can make their own feedback more easily, especially for instructors that want to use a deduction system instead of additive using compliments. https://pedal-edu.github.io/pedal/teachers/tools/ffs.html
For the formatter, we might want to add a little extra text at the beginning notating that this will mostly be used by environments (if my interpretation of this is incorrect, then we should have some explanatory text that talks about why we have the formatter.
In the teacher reference, the documentation doesn't parallel the actual documentation. Is this intended? E.g. verify notes you can pass in the code and file names, but doesn't indicate how that might happen.
The run documentation in here doesn't talk about the inputs field (e.g. for the input function). It could be a quick reference saying it's similar to set_input, but I feel like most instructors will just expect this to just run. Don't know if we want to add something about sys.args in here as well.
We could add a note that simple cases of recursion can be dealt with using CAIT for prevent_advanced_iteration if we want to. We might even think about a detect recursion function
Do we want to update the best practices page?
in the sample for the addition error in the feedback functions page, we might want to modify that example to use CAIT instead
In the text for the documentation for the feedback function, we might want to indicate examples of "core feedback functions"
It might be good to specify what environments should specify when they are created
hashtag in https://pedal-edu.github.io/pedal/teachers/integrations.html

Uh oh!

Improve Documentation #111

Description

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions