lesson-example
lesson-example copied to clipboard
carpentries
ep6: Do not use subheadings -- really?
In episode 4 there is a recommendation not to use sub-titles in episodes.
Perhaps it's a wording ambiguity, but that very page (and indeed the whole lesson example repo) makes extensive use of subtitles - and to good effect; breaking the prose up into navigable chunks. However, no justification is given for this recommendation.
I was proposing to use some sub-headings in the MATLAB lesson, and hence this discussion.
I think it will make the lesson material easier to teach and easier to follow for learners.
What are the current thoughts on this?
@gcapes, I could be wrong, but I think the distinction is sub-title versus sub-heading. H2 and H3 formatting is wonderful for breaking up walls of text. However, the title and subtitle are set in the yaml header. All lessons have titles. Most (if not all) lessons have H2 headers. No lessons have sub-titles as defined in the yaml header.
Does that make sense?
@raynamharris Thanks - what you wrote makes perfect sense, but I still think the lesson template page I linked to is confusing on this point.
@gcapes @maxim-belkin I suggested a change in https://github.com/carpentries/lesson-example/pull/225. not sure if that works or helps...