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

Re-entering conflict-free typos from deleted PR 1331 #1391

Merged
merged 2 commits into from Dec 15, 2017

Conversation

Projects
None yet
4 participants
@justbennet
Contributor

justbennet commented Dec 14, 2017

I believe these are all the corrections that are left that were not addressed by the documentation in the current master branch. I am not able to run make on this, as that seems to want to download data and run dypy. If there is a way to make just the documentation and you can send me instructions and/or a link to the instructions for making just the docs, then I will be happy to give it a try.

Sorry for all the hassle this has caused.

@codecov-io

This comment has been minimized.

codecov-io commented Dec 14, 2017

Codecov Report

Merging #1391 into master will increase coverage by <.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1391      +/-   ##
==========================================
+ Coverage   87.07%   87.07%   +<.01%     
==========================================
  Files         227      227              
  Lines       29060    29060              
  Branches     3123     3123              
==========================================
+ Hits        25303    25304       +1     
  Misses       3047     3047              
+ Partials      710      709       -1
Impacted Files Coverage Δ
dipy/core/graph.py 75% <0%> (+1.19%) ⬆️

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 e34445c...5a5b8c1. Read the comment docs.

@skoudoro

This comment has been minimized.

Member

skoudoro commented Dec 14, 2017

Thanks for doing this @justbennet and Thanks for the review @jchoude !

Unfortunately, there is no way to generate the documentation gallery without running examples but it should be easy to add a command for doing that.

Otherwise, everything else can be checked via make api and then make html-after-examples.

@jchoude

This comment has been minimized.

Contributor

jchoude commented Dec 14, 2017

@skoudoro Want to have a look, or we can merge? It is straight forward. I looked, all good. Was just waiting for the checks to finish, and they just did.

@justbennet

This comment has been minimized.

Contributor

justbennet commented Dec 14, 2017

@jchoude Did the annotation at the bottom work out OK?

I don't know how many people there are like me who don't run the software but do read the docs. I help other people, and my laptop isn't really suitable to run Dipy. I do use it to read documentation, though. I think the software needed to make just the documenation would be supportable. Up to you folks.

@skoudoro

This comment has been minimized.

Member

skoudoro commented Dec 14, 2017

There is the same error on these 3 files:

It would be great if you can remove all spaces from these files @justbennet :-)

After that, we can merge it.

Thanks !

@justbennet

This comment has been minimized.

Contributor

justbennet commented Dec 14, 2017

I don't understand. I did not touch those file at all.

@justbennet

This comment has been minimized.

Contributor

justbennet commented Dec 14, 2017

I touched one file only, doc/examples/gradients_spheres.py

I don't think any of the textual changes I made would ripple out to any other files.

@jchoude

This comment has been minimized.

Contributor

jchoude commented Dec 14, 2017

I think that @skoudoro meant that, at the same time, if you could additionnally fix it in the other files, he would be appreciative :)

And I understand your comment about just generating the documentation without running everything. The situation is that all images and screenshots are generated directly using the software, so, for the example to completly render, they need to do some processing.

@skoudoro

This comment has been minimized.

Member

skoudoro commented Dec 14, 2017

Exactly, Thanks @jchoude , and sorry if I was not clear.

@justbennet

This comment has been minimized.

Contributor

justbennet commented Dec 14, 2017

Ah. OK. What spaces? The trailing space at the end of those files?

@skoudoro

This comment has been minimized.

Member

skoudoro commented Dec 14, 2017

yes

@justbennet

This comment has been minimized.

Contributor

justbennet commented Dec 14, 2017

I believe I did as you requested. Sorry for the delay. I am at a different machine and had to reclone the repository.

@jchoude

This comment has been minimized.

Contributor

jchoude commented Dec 14, 2017

No problem! Thanks a lot for your patience with us!

I'm just waiting on the CI to finish.

@jchoude

This comment has been minimized.

Contributor

jchoude commented Dec 15, 2017

I generated the rst files locally, and the all render correctly. Merging!

Thanks @justbennet for your work!

@jchoude jchoude merged commit c15c3ee into nipy:master Dec 15, 2017

3 checks passed

codecov/patch Coverage not affected when comparing e34445c...5a5b8c1
Details
codecov/project 87.07% (+<.01%) compared to e34445c
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
@justbennet

This comment has been minimized.

Contributor

justbennet commented Dec 15, 2017

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

Merge pull request nipy#1391 from justbennet/gradients-spheres-typos
Re-entering conflict-free typos from deleted PR 1331
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment