[DOCS][CHORE] Add docs for IOConfig and S3Config #1227
Merged
Conversation
This file contains 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
github-actions
bot
added
chore
documentation
jaychia
commented
Aug 3, 2023
| @@ -2,8 +2,7 @@ | |||
|
|
|||
| import json | |||
|
|
|||
| from daft.daft import PyIOConfig as IOConfig | |||
| from daft.daft import PyS3Config as S3Config | |||
| from daft.daft import IOConfig, S3Config | |||
There was a problem hiding this comment.
Note: I had to do this because it seems Sphinx really doesn't like aliasing. The docstrings were never getting picked up, instead only ever showing up as alias of PyIOConfig.
Tried proposed solutions here to no avail: StackOverflow qn
jaychia
changed the title
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #1227 +/- ##
==========================================
- Coverage 88.10% 88.09% -0.01%
==========================================
Files 56 56
Lines 5656 5655 -1
==========================================
- Hits 4983 4982 -1
Misses 673 673
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Adds documentation for IOConfig and S3Config
Closes: #1106