python-novice-inflammation icon indicating copy to clipboard operation
python-novice-inflammation copied to clipboard

Lesson Contribution - Suggested Glossary changes

Open Talishask opened this issue 2 years ago • 0 comments

I'm a member of The Carpentries Core Team and I'm submitting this issue on behalf of another member of the community. In most cases, I won't be able to follow up or provide more details other than what I'm providing below.


Suggested Glossary changes

(1) assertions.

If assertions remain in the lesson ( I agree with Issue #979 and others in the gitHub that exceptions are a more appropriate tool for defensive programming - assertions are best used for debugging ), including a glossary term for assertion error would assist. Proposed wording below:

assertion error

An error which is generated if the condition associated with an assertion expression is evaluated to be False

Reference to the error would appear in the Defensive Programming episode, for example

If it is true, Python does nothing, but if it is false, Python halts the problem immediately using an assertion error (../reference ...) and prints out the error message if one is provided

(2) very minor typo There is a " at the end of the mutable explanation

Given that odd " and ' are an issue in coding, I think it best to avoid them in text.

mutable

Changeable. The value of mutable data can be altered after it has been created. See immutable."

Talishask avatar May 26 '22 17:05 Talishask