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

DOC: Fix reconst_mapmri example markup. #1423

Merged
merged 1 commit into from Apr 14, 2018

Conversation

jhlegarreta
Copy link
Contributor

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
Copy link
Contributor Author

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
Copy link

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
Copy link
Contributor Author

This branch addresses the rendering issues reported in #1291.

@jhlegarreta jhlegarreta force-pushed the FixReconstMAPMRIExampleFormatting branch from ff5b63d to 4e6ccee Compare February 11, 2018 13:59
jhlegarreta pushed a commit to jhlegarreta/dipy that referenced this pull request Feb 11, 2018
Following the discussion in dipy#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
Copy link
Member

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
Copy link
Member

skoudoro commented Mar 5, 2018

can you rebase this one too @jhlegarreta? thank you

@jhlegarreta jhlegarreta force-pushed the FixReconstMAPMRIExampleFormatting branch from 4e6ccee to b4eb160 Compare March 5, 2018 17:55
@jhlegarreta
Copy link
Contributor Author

@skoudoro Sure. b4eb160 was rebased on master.

@jhlegarreta
Copy link
Contributor Author

@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
Copy link
Member

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 FixReconstMAPMRIExampleFormatting branch from b4eb160 to 1bee094 Compare April 14, 2018 11:04
@jhlegarreta
Copy link
Contributor Author

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

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
Copy link
Member

Thank you @jhlegarreta, merging !

@skoudoro skoudoro merged commit 2b60458 into dipy:master Apr 14, 2018
ShreyasFadnavis pushed a commit to ShreyasFadnavis/dipy that referenced this pull request Sep 20, 2018
…Formatting

DOC: Fix `reconst_mapmri` example markup.
@jhlegarreta jhlegarreta deleted the FixReconstMAPMRIExampleFormatting branch October 10, 2018 02:05
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.

None yet

3 participants