merely-useful / py-rse

Research Software Engineering with Python course material
http://third-bit.com/py-rse/
Other
246 stars 63 forks source link

Error overview revised #550

Closed gvwilson closed 3 years ago

gvwilson commented 3 years ago

548 added a short introduction to error handling to the top of the chapter, but the content duplicated material from further down. This PR moves that existing material to the top of the chapter (including glossary links and index terms) and turns the bit that was left over into a callout box.

Replaces #548.

k8hertweck commented 3 years ago

I wouldn't mind this change; it makes sense logically to talk internal errors first, then broaden out to external.

I'm working on Amira's repo tomorrow, so I'll check back to see if we've decided to make this update so I'll know how to proceed.

gvwilson commented 3 years ago

This PR swaps the order of the chapters and moves one exercise to match. There is no longer any mention of exception in the testing chapter, and no forward references from it to the errors chapter. Please let me know if I've missed anything.

gvwilson commented 3 years ago

All changes made, and the order of the sections in solutions has been swapped (thanks for catching that).