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: Fix `reconst_mapmri` example markup. #1423

Merged
merged 1 commit into from Apr 14, 2018

Conversation

Projects
None yet
3 participants
@jhlegarreta
Contributor

jhlegarreta commented Feb 11, 2018

Fix formatting issues in the reconst_mapmri file to get the
documentation correctly rendered in:
http://nipy.org/dipy/examples_built/reconst_mapmri.html#example-reconst-mapmri

Changes:

  • Indent lists properly.
  • Indent literal blocks properly.
  • Remove unnecessary double quotes for indented code/literal blocks.
  • Use double backquotes for inline code samples.
@jhlegarreta

This comment has been minimized.

Contributor

jhlegarreta commented Feb 11, 2018

Any ideas as to why the following code block is not correctly rendered?

We can then fit the MAPMRI model to the data.

::
    mapfit_laplacian_aniso = map_model_laplacian_aniso.fit(data_small) mapfit_positivity_aniso =
 map_model_positivity_aniso.fit(data_small) mapfit_both_aniso = map_model_both_aniso.fit(data_small) 

And why the RTOP figures are all black (dynamic range issues?)

Thanks.

@codecov-io

This comment has been minimized.

codecov-io commented Feb 11, 2018

Codecov Report

Merging #1423 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@          Coverage Diff           @@
##           master   #1423   +/-   ##
======================================
  Coverage    87.5%   87.5%           
======================================
  Files         241     241           
  Lines       30701   30701           
  Branches     3323    3323           
======================================
  Hits        26866   26866           
  Misses       3059    3059           
  Partials      776     776

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 69b500c...1bee094. Read the comment docs.

@jhlegarreta

This comment has been minimized.

Contributor

jhlegarreta commented Feb 11, 2018

This branch addresses the rendering issues reported in #1291.

@jhlegarreta jhlegarreta force-pushed the jhlegarreta:FixReconstMAPMRIExampleFormatting branch from ff5b63d to 4e6ccee Feb 11, 2018

jhlegarreta pushed a commit to jhlegarreta/dipy that referenced this pull request Feb 11, 2018

Jon Haitz Legarreta
ENH: Use the CFIN dataset rather than the CENIR dataset.
Following the discussion in nipy#1423, use the CFIN dataset instead of the
CENIR dataset.

Also, make an explicit mention to the `MAPL` acronym so that the use of
the Laplacian-regularized MAP-MRI method seems no longer to be hidden.
@skoudoro

This comment has been minimized.

Member

skoudoro commented Feb 12, 2018

Any ideas as to why the following code block is not correctly rendered?

I think this has been corrected here. A "space" was missing.

And why the RTOP figures are all black (dynamic range issues?)

No idea for the moment

@skoudoro

This comment has been minimized.

Member

skoudoro commented Mar 5, 2018

can you rebase this one too @jhlegarreta? thank you

@jhlegarreta jhlegarreta force-pushed the jhlegarreta:FixReconstMAPMRIExampleFormatting branch from 4e6ccee to b4eb160 Mar 5, 2018

@jhlegarreta

This comment has been minimized.

Contributor

jhlegarreta commented Mar 5, 2018

@skoudoro Sure. b4eb160 was rebased on master.

@jhlegarreta

This comment has been minimized.

Contributor

jhlegarreta commented Mar 27, 2018

@skoudoro Codecov reports a decrease in the coverage but this is only a documentation change, so I think this is ready to be merged

@skoudoro

This comment has been minimized.

Member

skoudoro commented Apr 13, 2018

Sorry for the delay @jhlegarreta, I agree, it is ready to be merged, can you rebase and I can do it when it is done.
Thank you

@jhlegarreta jhlegarreta force-pushed the jhlegarreta:FixReconstMAPMRIExampleFormatting branch from b4eb160 to 1bee094 Apr 14, 2018

@jhlegarreta

This comment has been minimized.

Contributor

jhlegarreta commented Apr 14, 2018

No worries @skoudoro. 1bee094 was rebased on top of master.

Jon Haitz Legarreta
DOC: Fix `reconst_mapmri` example markup.
Fix formatting issues in the `reconst_mapmri` file to get the
documentation correctly rendered in:
http://nipy.org/dipy/examples_built/reconst_mapmri.html#example-reconst-mapmri

Changes:
- Indent lists properly.
- Indent literal blocks properly.
- Remove unnecessary double quotes for indented code/literal blocks.
- Use double backquotes for inline code samples.
@skoudoro

This comment has been minimized.

Member

skoudoro commented Apr 14, 2018

Thank you @jhlegarreta, merging !

@skoudoro skoudoro merged commit 2b60458 into nipy:master Apr 14, 2018

3 checks passed

codecov/patch Coverage not affected when comparing 69b500c...1bee094
Details
codecov/project 87.5% remains the same compared to 69b500c
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

ShreyasFadnavis pushed a commit to ShreyasFadnavis/dipy that referenced this pull request Sep 20, 2018

Merge pull request nipy#1423 from jhlegarreta/FixReconstMAPMRIExample…
…Formatting

DOC: Fix `reconst_mapmri` example markup.

@jhlegarreta jhlegarreta deleted the jhlegarreta:FixReconstMAPMRIExampleFormatting branch Oct 10, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment