Merged
Conversation
Contributor
Author
|
@FChataigner would you mind reviewing some docstring updates to fill out the docs more on some functions that are undocumented? |
FChataigner
requested changes
Jul 20, 2021
dataikuapi/dss/project.py
Outdated
|
|
||
| .. warning:: | ||
|
|
||
| this stream will monopolize the DSSClient until closed, so the stream must be closed after use or used within a ``with`` statement. For example: |
Contributor
There was a problem hiding this comment.
I'd drop the "this stream will monopolize the DSSClient until closed" and just say what needs to be done
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adding some minor changes to improve the docs for the following:
bundlemethodsoutputtypes - in combination with https://github.com/dataiku/dss-doc/pull/538 to help clarify job output syntax and available types