should `discussion` be included in the exercise list directive?

coderefinery / sphinx-lesson

Sphinx extension for creating CodeRefinery lessons

https://coderefinery.github.io/sphinx-lesson/

MIT License

14 stars 20 forks source link

should `discussion` be included in the exercise list directive? #101

Open rkdarst opened 1 year ago

rkdarst commented 1 year ago

reasons for (+) and against (-)

(-) They usually don't require preparation by exercise leaders
(+) seeing them helps to understand the overall flow of the lesson
(+) they often have a solution after, which would be included in the exercise list anyway. This would be confusing.
(-) the page could start to get very long.

bast commented 1 year ago

I am unsure and still thinking. Can really see it both ways. I wanted to write this to not leave this empty-commented.

rkdarst commented 1 year ago

I sort of assume that many "discussion"s end up becoming "discuss in your groups" in cases where they exist and are the primary way of doing things. Though I guess in some lessons, there are discussions that would be whole-room discussions no matter what? The new sphinx-lesson change lets us put any specific boxes in the exercise list, though I wouldn't recommend getting too fancy about it...

rkdarst commented 1 year ago

I'm leaning to "not by default", but it can easily be enabled where it makes sense... it really depends on what the exercise list is for.

I imagine that the exercise list can be used to generate a full summary of the lesson my collecting all the questions/objectives/key points. That would require design specifically for this, and I'm not sure if it has any practical purpose and it is a lot of work.