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

MAINT: Updates for better docs generation. #1890

Merged
merged 4 commits into from Aug 10, 2017

Conversation

Projects
None yet
3 participants
@ssanderson
Member

ssanderson commented Jul 18, 2017

  • Add compat function for functools.wraps.
  • Add is_sentinel check.
  • Add docstrings to some pipeline methods.

@ssanderson ssanderson requested a review from freddiev4 Jul 18, 2017

@coveralls

This comment has been minimized.

coveralls commented Jul 18, 2017

Coverage Status

Coverage decreased (-0.002%) to 87.49% when pulling 9839518 on use-compat-wraps into 07a0f6a on master.

@@ -27,9 +33,8 @@ def sentinel(name, doc=None):
) % (name, value.__doc__, doc))

@object.__new__ # bind a single instance to the name 'Sentinel'
class Sentinel(object):
class Sentinel(_Sentinel):

This comment has been minimized.

@freddiev4

freddiev4 Jul 20, 2017

Contributor

Should we add a comment here explaining why we did this?

This comment has been minimized.

@ssanderson

ssanderson Aug 4, 2017

Member

I moved is_sentinel up to the top of this file to make it clearer that the base class exists so that we can use isinstance for is_sentinel.

@coveralls

This comment has been minimized.

coveralls commented Aug 4, 2017

Coverage Status

Coverage increased (+0.0008%) to 87.493% when pulling b75bd76 on use-compat-wraps into 07a0f6a on master.

1 similar comment
@coveralls

This comment has been minimized.

coveralls commented Aug 4, 2017

Coverage Status

Coverage increased (+0.0008%) to 87.493% when pulling b75bd76 on use-compat-wraps into 07a0f6a on master.

ssanderson added some commits Jul 18, 2017

MAINT: Updates for better docs generation.
- Add compat function for `functools.wraps`.
- Add `is_sentinel` check.
- Add docstrings to some pipeline methods.
MAINT: Updates for better docs generation.
- Add compat function for `functools.wraps`.
- Add `is_sentinel` check.
- Add docstrings to some pipeline methods.

@freddiev4 freddiev4 force-pushed the use-compat-wraps branch from 67f456e to a0c0116 Aug 10, 2017

@coveralls

This comment has been minimized.

coveralls commented Aug 10, 2017

Coverage Status

Coverage decreased (-0.002%) to 87.498% when pulling a0c0116 on use-compat-wraps into 7f5d852 on master.

MAINT: Updates for better docs generation.
- Add compat function for `functools.wraps`.
- Add `is_sentinel` check.
- Add docstrings to some pipeline methods.
@coveralls

This comment has been minimized.

coveralls commented Aug 10, 2017

Coverage Status

Coverage decreased (-0.002%) to 87.498% when pulling 4f79776 on use-compat-wraps into 7f5d852 on master.

1 similar comment
@coveralls

This comment has been minimized.

coveralls commented Aug 10, 2017

Coverage Status

Coverage decreased (-0.002%) to 87.498% when pulling 4f79776 on use-compat-wraps into 7f5d852 on master.

@freddiev4 freddiev4 merged commit d3e0314 into master Aug 10, 2017

2 checks passed

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

@freddiev4 freddiev4 deleted the use-compat-wraps branch Aug 10, 2017

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