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

Fix missing documentation content #1255

Merged
merged 8 commits into from
Jun 16, 2017

Conversation

skoudoro
Copy link
Member

All dipy.*.utils (ex: dipy.tracking.utils) are missing on the documentation so this PR change the regular expression to make this files available on api reference. (see #322)

@skoudoro skoudoro changed the title Fix missing "utils" documentation content Fix missing documentation content Jun 13, 2017
@skoudoro
Copy link
Member Author

I should add a modification for resolving #570 at the same time

@codecov-io
Copy link

codecov-io commented Jun 13, 2017

Codecov Report

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

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1255   +/-   ##
=======================================
  Coverage   87.04%   87.04%           
=======================================
  Files         226      226           
  Lines       28262    28262           
  Branches     3026     3026           
=======================================
  Hits        24602    24602           
  Misses       2976     2976           
  Partials      684      684
Impacted Files Coverage Δ
dipy/viz/actor.py 78.18% <ø> (ø) ⬆️
dipy/tracking/utils.py 86.89% <ø> (ø) ⬆️

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 599af3e...196ff8e. Read the comment docs.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 85.656% when pulling bf7743d on skoudoro:fix_missing_documentation_content into 599af3e on nipy:master.

1 similar comment
@coveralls
Copy link

Coverage Status

Coverage remained the same at 85.656% when pulling bf7743d on skoudoro:fix_missing_documentation_content into 599af3e on nipy:master.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 85.656% when pulling ef0ff53 on skoudoro:fix_missing_documentation_content into 599af3e on nipy:master.

1 similar comment
@coveralls
Copy link

Coverage Status

Coverage remained the same at 85.656% when pulling ef0ff53 on skoudoro:fix_missing_documentation_content into 599af3e on nipy:master.

@arokem
Copy link
Contributor

arokem commented Jun 13, 2017

Does this build the docs OK? Because full documentation building takes a while (the examples take a while to run), you can relatively quickly test this by removing most of the lines in this file: https://github.com/nipy/dipy/blob/master/doc/examples/valid_examples.txt

@skoudoro
Copy link
Member Author

I just tried to generate the API reference via "make api" command, and the *.rst generated was ok.

I will generate the full documentation a little bit later to be sure that everything is ok and let you know.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 85.656% when pulling 36040e2 on skoudoro:fix_missing_documentation_content into 599af3e on nipy:master.

1 similar comment
@coveralls
Copy link

Coverage Status

Coverage remained the same at 85.656% when pulling 36040e2 on skoudoro:fix_missing_documentation_content into 599af3e on nipy:master.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 85.656% when pulling a0fb0ef on skoudoro:fix_missing_documentation_content into 599af3e on nipy:master.

1 similar comment
@coveralls
Copy link

Coverage Status

Coverage remained the same at 85.656% when pulling a0fb0ef on skoudoro:fix_missing_documentation_content into 599af3e on nipy:master.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 85.656% when pulling d5ad16c on skoudoro:fix_missing_documentation_content into 599af3e on nipy:master.

1 similar comment
@coveralls
Copy link

Coverage Status

Coverage remained the same at 85.656% when pulling d5ad16c on skoudoro:fix_missing_documentation_content into 599af3e on nipy:master.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 85.656% when pulling 196ff8e on skoudoro:fix_missing_documentation_content into 599af3e on nipy:master.

1 similar comment
@coveralls
Copy link

Coverage Status

Coverage remained the same at 85.656% when pulling 196ff8e on skoudoro:fix_missing_documentation_content into 599af3e on nipy:master.

@arokem
Copy link
Contributor

arokem commented Jun 16, 2017

This looks ready to go. I'll merge this, and if there are any follow-ups, we can take them on a separate PR.

@arokem arokem merged commit 9ab8d60 into dipy:master Jun 16, 2017
@skoudoro skoudoro deleted the fix_missing_documentation_content branch June 17, 2017 00:39
ShreyasFadnavis pushed a commit to ShreyasFadnavis/dipy that referenced this pull request Sep 20, 2018
…content

Fix missing documentation content
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.

4 participants