-
Notifications
You must be signed in to change notification settings - Fork 100
MRG: Improve doc #205
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
MRG: Improve doc #205
Conversation
Ready for review/merge from my end. Updated docs here. |
Setting back to WIP because the SG names may change. But still ready for review / perusal of the doc because that shouldn't change. |
Okay this one should be good to go. Includes a small fix for Travis. |
brain.screenshot() | ||
if not sys.platform.startswith('linux') or \ | ||
os.getenv('TRAVIS', 'false') != 'true': |
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.
so this will not run on any linux system ?
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.
It runs fine on my local Linux, I'm assuming it's an Xvfb / temporary Mayavi bug
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.
if you're asking about the conditional -- these lines will run if the system is not linux or it's not travis (same as not (linux and travis)
)
ok +1 for MRG then
|
Okay with you @mwaskom? |
@@ -1186,7 +1186,7 @@ def add_annotation(self, annot, borders=True, alpha=1, hemi=None, | |||
hemisphere, i.e. ``annot=(labels, ctab)`` for a single hemisphere | |||
or ``annot=((lh_labels, lh_ctab), (rh_labels, rh_ctab))`` for both | |||
hemispheres. ``labels`` and ``ctab`` should be arrays as returned | |||
by :func:`nibabel.freesurfer.read_annot`. | |||
by :func:`nibabel.freesurfer.io.read_annot`. |
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.
Is nibabel changing its imports? nib.freesurfer.read_annot
has always worked for me.
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.
It is probably imported both places, but this is where it lives in their docs (sphinx index) so this is necessary for it to link properly.
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.
Ah got it.
I don't have time to build the docs and look but the code changes seem good. Note the one comment. |
Thanks for the looks, I'll work on cutting a release now |
Closes #199.
Todo:
Still need to make sure the rest of the issues in there are addressed.In the meantime, the first commit fixes the vector example build (wouldn't work on OSX -- figures are closed at the end of each SG section).