computer-aided-biotech / better-cb

A compendium of tools for (better) computational biology.
Other
4 stars 3 forks source link

review-branch #27

Closed BenjaSanchez closed 3 years ago

BenjaSanchez commented 3 years ago

wip review branch

BenjaSanchez commented 3 years ago

@dcsoto I went through all of section 1 (personal research). I commited all my changes, so feel free to carry on the review on top of that. As we are working at non-overlapping hours, I think it would be optimal if you do the same at the end of your day, that way I can continue reviewing tomorrow section 2 :)

An observation on Section 1.4: With the use of Git, adding the author and the date of the code is as far as I know discouraged, as it is redundant information (it can be inferred from git blame). Should we include it as something elective? Let me know if you like the way I left it.

dcsoto commented 3 years ago

It makes sense, it can be redundant if the code is in Git. I will look for more advice on what to add to the header and likely remove it from that section. Thanks!