search

ktakagaki / hayabaya

0 stars 0 forks source link

Dev #3

Closed ghost closed 9 years ago

ghost commented 9 years ago

I am reading the code and looking at my notes from our previous meetings.

I really should try to write down more "Why" and not "how" comments when we meet the next time. Because right now, I can't figure out why Utility.writeResultsToCsv(Results results) was deprecated. What is the purpose of the integer repetitionsTag?

Also, what are the best options for annotating the code and asking questions like the one above online? I am using a git pull request this time, but are there other ways that would be better?

Cheers, Soren

ktakagaki commented 9 years ago

To be honest, I can't remember why either. It could have been because we were talking about refactoring it to Results.writeToCsv(), from an OOP point of view, that would make some sense. (Functional-wise, having a Utility class with a lot of things is pretty fine, but)

repetitionsTag I think was meant to be used if you wanted to output several runs of a condition. If you just used the current writeResultsToCsv, the files would just be overwritten one after another, but if you had a counter (it just has to be a different number) within the filename, you could keep each result.

For Github for such things, I would use line comments. Navigate to the line in question on the website, and add a comment with my @ktakagaki tag.

Kenta

Kentaroh Takagaki, MD PhD (高垣 堅太郎) Group Leader, AG Neuro-Optics Department Systems Physiology of Learning Leibniz Institute for Neurobiology <kentaroh.takagaki@lin-magdeburg.de kentaroh.takagaki@ifn-magdeburg.de> http://www.lin-magdeburg.de/en/ifn_mp.jsp?member=ktakagak&fc=T

On Sat, May 9, 2015 at 10:26 PM, Slentzen Demian notifications@github.com wrote:

I am reading the code and looking at my notes from our previous meetings.

I really should try to write down more "Why" and not "how" comments when we meet the next time. Because right now, I can't figure out why Utility.writeResultsToCsv(Results results) was deprecated. What is the purpose of the integer repetitionsTag?

Also, what are the best options for annotating the code and asking questions like the one above online? I am using a git pull request this time, but are there other ways that would be better?

Cheers,

Soren

You can view, comment on, or merge this pull request online at:

https://github.com/ktakagaki/hayabaya/pull/3 Commit Summary

  • run passed
  • Merged conflix into HEAD
  • Merge pull request #1 from ktakagaki/master
  • Merge branch 'logging'
  • Deleting usage of println statements and functions not strictly related to the profiling project

File Changes

Patch Links:

— Reply to this email directly or view it on GitHub https://github.com/ktakagaki/hayabaya/pull/3.

ghost commented 9 years ago

Okay, I am trying to comment on code lines and @mention you.

I suppose it will take some work to untangle this clusterfuck of not properly documenting and commenting my code while I wrote it. A tough way to learn a lesson a read in "Clean Code" several times, but kept on being to arrogant to think it would happen to me.