Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix authoring coherence #295

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

SylvainLan
Copy link
Contributor

fix issue #147
I used the way @dohmatob commented most of his files, namely:

"""
:Module: module name
:Synopsis: Module function
:Author: LASTNAME Firstname 

"""

There is still some incoherence, for instance whether or not I add the Module and/or the Synopsis to the header, which I could do.
I could also add another line for the author mail address

:module: st
:synopsis: module for STC (Slice-Timing Correction) in fMRI data
:author: elvis[dot]dohmatob[at]inria[dot]fr
:Module: st
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

st -> slice timing, but I'd remove it for the sake of homogeneity.

@@ -2,7 +2,7 @@
"""
Created on Thu Aug 6 10:01:12 2015

@author: Mehdi RAHIM, Jerome DOCKES
:Author: RAHIM Mehdi, DOCKES Jerome
"""
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you add a synopsis for the sake of homogeneity ?

@@ -1,7 +1,7 @@
"""
:Module: utils
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove that one for the sake of homogeenity ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants