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

Update client.py by @tharris72 #5670

Merged
merged 19 commits into from
Jan 21, 2022
Merged

Conversation

jsignell
Copy link
Member

Adding the Returns numpy style documentation to the doc strings. This is for issue #3578.
Testing out the pull request to make sure it works. There are still more doc strings to update.

This replaces #4517 since that PR got pretty stale. I'll merge this today if there are now complaints.

tharris72 and others added 18 commits January 19, 2022 10:52
Adding the Returns numpy style documentation to the doc strings. This is for issue dask#3578
more updates to the doc strings
	modified:   distributed/client.py
	testing out the commit
	modified:   distributed/client.py
	modified:   distributed/client.py
	modified:   distributed/utils.py
	modified:   distributed/client.py
	modified:   distributed/pubsub.py
Fixing the doc string warnings from flake8
more flake8 updates
more flake8 updates
more flake8 updates
more flake8 updates
more flake8 updates
more flake8 updates
more flake8 updates
more flake8 updates
@jsignell jsignell mentioned this pull request Jan 19, 2022
@jsignell jsignell merged commit b341711 into dask:main Jan 21, 2022
@jsignell jsignell deleted the tharris72-client-docs branch January 21, 2022 18:53
@jsignell
Copy link
Member Author

Thanks @tharris72 this is in!

Copy link
Member

@jrbourbeau jrbourbeau left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @jsignell @tharris72 -- apologies for the late review

Comment on lines +262 to +265
Returns
-------
result : asyncio.Future
The Future that contains the result of the computation
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is be incorrect. Future.result() should return the actual result (or a coroutine if the Client is in asynchronous mode).

Comment on lines +421 to +425
Returns
-------
Future
The Future that contains the traceback

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Similar comment here, this returns the actual traceback object (or coroutine)

Parameters
----------
_in_destructor: bool
Not used
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this isn't ever used, then I'd prefer to remove it altogether

Comment on lines +690 to +693
serializers
The serializers to turn an object into a string
deserializers
The deserializers to turn the string into the original object
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(De)Serializers don't convert to strings

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.

None yet

3 participants