-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Open
Description
Perhaps this is somewhat pedantic, but I wonder whether we should be move from an unordered list of terms to a definition list for the glossary?
This would be more semantically correct and would allow us to avoid manual hard breaks in our current source text, e.g.:
- allocate:\
Dynamic memory allocation on [the heap](memory-management/review.md).
- argument:\
Information that is passed into a function or method.
- associated type:\
A type associated with a specific trait. Useful for defining the relationship
between types.
Unfortunately, it looks as though current markdown processor does not support the extended syntax for dl
, dt
and dd
tags.
That would mean that we would be required to hand-write HTML:
<dl>
<dt>allocate</dt>
<dd>Dynamic memory allocation on <a href="memory-management/review.html">the heap</a>.</dd>
<dt>argument</dt>
<dd>Information that is passed into a function or method.</dd>
<dt>associated type</dt>
<dd>A type associated with a specific trait. Useful for defining the relationship between types.</dd>
…which would unlock the ability to refer to the glossary from other parts of the course.
<dt id="allocate">allocate</dt>
<dd>Dynamic memory allocation on <a href="memory-management/review.html">the heap</a>.</dd>
Metadata
Metadata
Assignees
Labels
No labels