🔭 🎓 Improve use of Stack vs stack, Queue vs queue, etc.
#798
Labels
consistency --- telescope 🔭
Using different words/code for the same ideas
content --- mortar_board 🎓
Related to course content (topics, assignments, etc.)
Comments
jameshughes89
added
consistency --- telescope 🔭
YourLocalMedic
added a commit
to YourLocalMedic/cs102
that referenced
this issue
Jan 31, 2025
Improve usage of stack vs ``Stack`` in accordance with Issue jameshughes89#798. See line 199: previously *stack*, now *``Stack``*. I am unsure of how italics and code blocks interact and whether them being like that will make the website explode. Regardless, I'm unsure of how this unique case of emphasis should be handled. Also lines 5, 17, and 314: stacks to ``Stack``s rather than to ``Stacks`` as the Class is still called Stack not Stacks, and there could be confusion if the s is inside of the code block, though there may be disagreement on this matter, which is why I point it out
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
What
Improve the consistency with how the typesetting is used when referring to ADTs
Why
It's not consistent right now.
How
Right now this issue serves as a reminder for the next clean up of the content.
I'm not sure how best to come up with the rules for differentiating. It won't always be easy to draw a line, but when referring to the interface specifically, use, for example,
Stack, but when referring to just a stack, use "stack" --- e.g. "the top of the stack"The text was updated successfully, but these errors were encountered: