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

Projects
None yet
4 participants
@skoudoro
Member

skoudoro commented Jun 13, 2017

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 from Fix missing "utils" documentation content to Fix missing documentation content Jun 13, 2017

@skoudoro

This comment has been minimized.

Member

skoudoro commented Jun 13, 2017

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

@codecov-io

This comment has been minimized.

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

This comment has been minimized.

coveralls commented Jun 13, 2017

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

This comment has been minimized.

coveralls commented Jun 13, 2017

Coverage Status

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

@coveralls

This comment has been minimized.

coveralls commented Jun 13, 2017

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

This comment has been minimized.

coveralls commented Jun 13, 2017

Coverage Status

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

@arokem

This comment has been minimized.

Member

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

This comment has been minimized.

Member

skoudoro commented Jun 13, 2017

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

This comment has been minimized.

coveralls commented Jun 14, 2017

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

This comment has been minimized.

coveralls commented Jun 14, 2017

Coverage Status

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

@coveralls

This comment has been minimized.

coveralls commented Jun 14, 2017

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

This comment has been minimized.

coveralls commented Jun 14, 2017

Coverage Status

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

@coveralls

This comment has been minimized.

coveralls commented Jun 15, 2017

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

This comment has been minimized.

coveralls commented Jun 15, 2017

Coverage Status

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

@coveralls

This comment has been minimized.

coveralls commented Jun 16, 2017

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

This comment has been minimized.

coveralls commented Jun 16, 2017

Coverage Status

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

@arokem

This comment has been minimized.

Member

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 nipy:master Jun 16, 2017

4 checks passed

codecov/patch Coverage not affected when comparing 599af3e...196ff8e
Details
codecov/project 87.04% remains the same compared to 599af3e
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
coverage/coveralls Coverage remained the same at 85.656%
Details

@skoudoro skoudoro deleted the skoudoro:fix_missing_documentation_content branch Jun 17, 2017

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

Merge pull request nipy#1255 from skoudoro/fix_missing_documentation_…
…content

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