Ninth week of GSoC

sappelhoff
Published: 07/29/2019

1. What did you do this week?

I have compiled a list for week 9 in my changelog here: https://github.com/sappelhoff/gsoc2019/blob/master/changelog.md#week-9

2. What is coming up next?

Next, I will mostly work on the mne-study template. With Mainak, I discussed that the next step would be to implement a CI test suite.

3. Did you get stuck anywhere?

In the MNE-Python codebase there was a "magical" factor of 85 multiplied with a variable, and it was not documented where that was coming from. It took me a while to figure out (and verify!) that this is the average head radius (assuming an unrealistically spherical head) in millimeters. Now the documentation is much better, but it helped me to learn once more that one has to either
 

  • write clean code
    • e.g., instead of having the factor 85 there, make it a variable with the name `realistic_head_radius_mm` (or something like it)
  • write a good documentation
    • E.g., make short but instructive comments, or more exhaustive documentation in the function or module docstrings

 

probably a combination of both is best.

1000 characters left