[DOC] Fixed minor typos, grammar errors and moved imports up in all examples #2151
Conversation
|
Hello @ShrishtiHore, Thank you for updating !
Comment last updated at 2020-04-28 08:00:47 UTC |
ShrishtiHore
changed the title
Codecov Report
@@ Coverage Diff @@
## master #2151 +/- ##
==========================================
+ Coverage 91.24% 91.29% +0.04%
==========================================
Files 251 251
Lines 32228 32407 +179
Branches 3403 3416 +13
==========================================
+ Hits 29407 29586 +179
+ Misses 2084 2083 -1
- Partials 737 738 +1
|
There was a problem hiding this comment.
Hi @ShrishtiHore,
Thank you for doing this.
I had a quick look at this PR and it seems there is a lot of errors due to your rebase/merge so I did not go until the end. I can see some duplication, some lines removed when they should be there, etc....
Despite these problems, I tried to generate the documentation with your branch and it is failing despite a few corrections.
We have to be really careful with the documentation. As you know, I am already working on it (#1990) by cleaning, reshaping and running all tutorials individually. It takes 1h30 to generate the whole documentation on my laptop.
So I propose you just close this PR, review mine when I will push my update. Also, you can fork my branch from #1990 and can create a PR over it on my repo.
Let me know if you have any questions.
| @@ -108,7 +109,6 @@ def run(self, input_files, out_dir='', out_file='processed.nii.gz'): | |||
| file located in ``bin``. | |||
| """ | |||
|
|
|||
| from dipy.workflows.flow_runner import run_flow | |||
There was a problem hiding this comment.
You should keep this here because if you read the tutorial, the import are in 2 different files.
There was a problem hiding this comment.
okay thanks a lot.
|
|
||
| from dipy.data import get_fnames | ||
| from dipy.io.image import load_nifti, save_nifti | ||
| from dipy.segment.mask import median_otsu |
There was a problem hiding this comment.
the block above appears twice and is duplicated with the import on the top
| from dipy.data import get_fnames | ||
| from dipy.io.image import load_nifti, save_nifti | ||
| from dipy.segment.mask import median_otsu | ||
| from dipy.core.histeq import histeq |
There was a problem hiding this comment.
Why this one is not on the top ?
There was a problem hiding this comment.
Sorry made a mistake in there.
This PR is based on the previous PR's and discussions we had. I have moved the imports of all examples at the top of the code. I also tried fixing as many typos as I could.
It would be great if @skoudoro and @arokem please review it and give your feedback.
There are 4 files I didn't make any changes to because they were format(pattern) based examples with multiple samples in one source code. They are tracking_introduction.py, workflow_creation.py, segment_clustering_feature.py and segment_clustering_metric.py
Please check it out and tell any corrections needed.