generated from mwc/lab_dice
637a5e5191
Writing docstrings was different from writing code. One reason is that I was trying to understand code I hadn't written, so it may not have been written or presented in the way I would have conceived it. Similarly, I didn't necessarily know how each method related to the other, so instead of breaking down a problem into smaller ones, I was trying to understand how all of the pieces came together to create a version of Yahtzee. Another reason is that I don't write a lot of comments or docstrings in my own practice, so it's something I need to build a better habit of. I wasn't always sure if what I was writing captured what I needed to in a docstring. I do think in the future, I should write more docstrings, if not for myself than at least to model it for my students. I think partially this is because I usually write my projects in short bursts so the meaning is clear to me. I can see how it might have value if it's something others might look at or something I have to revisit later on after having not looked at it for a while.