-
-
Notifications
You must be signed in to change notification settings - Fork 54
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: Corrections to some of the parameter types in the docs and a couple lint-related fixes #653
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files
☔ View full report in Codecov by Sentry. |
pyvo/dal/vosi.py
Outdated
@@ -14,10 +14,10 @@ | |||
from ..utils.decorators import stream_decode_content, response_decode_content | |||
from ..utils.http import use_session | |||
|
|||
__all__ = ['CapabilityMixin', 'VOSITables'] | |||
__all__ = ['AvailabilityMixin', 'CapabilityMixin', 'VOSITables'] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
AvailabilityMixin is deprecated, please don't put it back here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh I missed that it was deprecated, I've removed it again
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Thank you
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OK, now it looks OK.
Btw, please don't add classes to __all__
just for lining purposes as we may omit some as non public API.
dal/query is not included in the API docs, so adding UploadList doesn't have an effect, yet, it should not be added just to make the linter happy.
As for the docstrings, thanks for fixing those. Adding a numpydoc linter to CI is on my list, so any cleanup is welcome for now.
Summary
This PR mostly is just to cleanup some of the documentation and specifically the parameter types. as well as a couple linting issues like classes missing from
__all__
declaration, unneeded parenthesis and changing camel-case to snake-case in one instance.Assuming these changes make sense, am I right to assume this doesn't need a changelog entry?