-
Notifications
You must be signed in to change notification settings - Fork 26
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
DOC: Bring implementation details to the foreground of documentation #248
Conversation
Codecov Report
@@ Coverage Diff @@
## master #248 +/- ##
==========================================
- Coverage 83.06% 82.64% -0.42%
==========================================
Files 25 25
Lines 1836 1902 +66
Branches 208 231 +23
==========================================
+ Hits 1525 1572 +47
- Misses 280 299 +19
Partials 31 31
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
496b7f2
to
518d7f9
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just some small things from me
Co-authored-by: Eilidh MacNicol <54267723+eilidhmacnicol@users.noreply.github.com>
Thanks much @eilidhmacnicol . Do you think you learned something? - this is just a start, but someone who reads it should end with a relatively clear idea of what's going on and how SDCFlows attacks the problem. |
Yes - as someone fairly representative of the target audience, the individual workflow functionalities were clear. There were some sentences that required a second read but I think, like you said, that it's a solid base. |
@effigies - if the docs do not clarify the answers to your question #247 (comment), then I need help improve this text. @mgxd - I believe this documentation should help a lot in identifying when a bug could come from (thinking of that weird flip in the direction of correction of your data). Also interested in your feedback. |
Will try to read through before our meeting. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is super useful, definitely helpful to digest some of what is going on during SDC
Co-authored-by: Mathias Goncalves <mathiasg@stanford.edu>
Co-authored-by: Mathias Goncalves <mathiasg@stanford.edu>
981538b
to
8726e6e
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good. Style issues only.
Co-authored-by: Chris Markiewicz <markiewicz@stanford.edu>
Trying to give some more visibility to the theory. Also, discussed a little about
find_estimators
(related to nipreps/fmriprep#2560)EDIT: Link to the new document - https://3553-189236569-gh.circle-artifacts.com/0/%7E/docs/docs_refactor-content-organization/methods.html