alan-turing-institute / rds-course

Materials for Turing's Research Data Science course
https://alan-turing-institute.github.io/rds-course/
31 stars 13 forks source link

Use of admonition / html tags #117

Open AoifeHughes opened 1 year ago

AoifeHughes commented 1 year ago

Just a thought whilst going through some of the first sections. I've noticed the use of details html tags to hide and show information. Are these vital or could we remove them? The primary reason I'd be inclined to remove is because they can cause issues with markdown e.g. they break []() linking.

Similarly, I've seen the admonition tag used a few times here, for example.. Does this add much, or could they also be removed?

I think it would generally help readability and compatibility (also happy to be told this is not something worth doing or that these things have a specific use!)