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

Various fixes to image utils docstrings #247

Merged
merged 3 commits into from Mar 27, 2015

Conversation

Projects
None yet
3 participants
@mapazarr
Member

mapazarr commented Mar 26, 2015

No description provided.

Show outdated Hide outdated gammapy/image/utils.py Outdated
Show outdated Hide outdated gammapy/image/utils.py Outdated
Show outdated Hide outdated gammapy/image/utils.py Outdated
Show outdated Hide outdated gammapy/image/utils.py Outdated
Show outdated Hide outdated gammapy/image/utils.py Outdated
@cdeil

This comment has been minimized.

Show comment
Hide comment
@cdeil

cdeil Mar 26, 2015

Member

@mapazarr – I've left a bunch of inline comments. It's tedious, but take it as an excercise to learn more about docstrings, Sphinx, git, travis-ci.

Member

cdeil commented Mar 26, 2015

@mapazarr – I've left a bunch of inline comments. It's tedious, but take it as an excercise to learn more about docstrings, Sphinx, git, travis-ci.

@mapazarr

This comment has been minimized.

Show comment
Hide comment
@mapazarr

mapazarr Mar 26, 2015

Owner

Many functions had undefined parameters in the doc strings (and no TODO to draw attention to it). Fixed.

Owner

mapazarr commented on dcf2589 Mar 26, 2015

Many functions had undefined parameters in the doc strings (and no TODO to draw attention to it). Fixed.

Show outdated Hide outdated gammapy/image/utils.py Outdated
Show outdated Hide outdated gammapy/image/utils.py Outdated
Show outdated Hide outdated gammapy/image/utils.py Outdated
@cdeil

This comment has been minimized.

Show comment
Hide comment
@cdeil

cdeil Mar 26, 2015

Member

@mapazarr - Nice! This time the travis-ci build passed.

I've left a few more small suggestions for improvement.
Once these are addressed this PR is ready.

Member

cdeil commented Mar 26, 2015

@mapazarr - Nice! This time the travis-ci build passed.

I've left a few more small suggestions for improvement.
Once these are addressed this PR is ready.

@coveralls

This comment has been minimized.

Show comment
Hide comment
@coveralls

coveralls Mar 26, 2015

Coverage Status

Coverage increased (+0.01%) to 46.06% when pulling dcf2589 on mapazarr:image_utils_pars into 8d70ef6 on gammapy:master.

coveralls commented Mar 26, 2015

Coverage Status

Coverage increased (+0.01%) to 46.06% when pulling dcf2589 on mapazarr:image_utils_pars into 8d70ef6 on gammapy:master.

@coveralls

This comment has been minimized.

Show comment
Hide comment
@coveralls

coveralls Mar 27, 2015

Coverage Status

Coverage increased (+0.01%) to 46.06% when pulling ed530f7 on mapazarr:image_utils_pars into 8d70ef6 on gammapy:master.

coveralls commented Mar 27, 2015

Coverage Status

Coverage increased (+0.01%) to 46.06% when pulling ed530f7 on mapazarr:image_utils_pars into 8d70ef6 on gammapy:master.

@cdeil

This comment has been minimized.

Show comment
Hide comment
@cdeil

cdeil Mar 27, 2015

Member

Perfect. Thanks!

Member

cdeil commented Mar 27, 2015

Perfect. Thanks!

cdeil added a commit that referenced this pull request Mar 27, 2015

Merge pull request #247 from mapazarr/image_utils_pars
Define input parameters and return values of methods in image utils.

@cdeil cdeil merged commit 01c2707 into gammapy:master Mar 27, 2015

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

@cdeil cdeil added cleanup docs labels Apr 8, 2015

@cdeil cdeil added this to the 0.2 milestone Apr 8, 2015

@cdeil cdeil changed the title from Define input parameters and return values of methods in image utils. to Various fixes to image utils docstrings Apr 8, 2015

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