[DOP-22433] Improve JSON/JSONLine documentation#359
Merged
Conversation
ddce800 to
a9cc05d
Compare
a9cc05d to
3a77761
Compare
3a77761 to
84150c3
Compare
84150c3 to
7405e2d
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop #359 +/- ##
===========================================
+ Coverage 92.50% 92.54% +0.04%
===========================================
Files 229 229
Lines 10021 10120 +99
Branches 1016 1017 +1
===========================================
+ Hits 9270 9366 +96
- Misses 562 566 +4
+ Partials 189 188 -1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
IlyasDevelopment
approved these changes
Mar 17, 2025
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
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.
Change Summary
Previously JSON and JSONLine classes documentation only noted that options are documented elsewhere. Now all of them are documented, included to constructor signature and can be recommended by IDE.
Almost all option values are None, and excluded from class repr.
Before:
https://onetl.readthedocs.io/en/0.13.3/file_df/file_formats/json.html
https://onetl.readthedocs.io/en/0.13.3/file_df/file_formats/jsonline.html
After:
https://onetl--359.org.readthedocs.build/en/359/file_df/file_formats/json.html
https://onetl--359.org.readthedocs.build/en/359/file_df/file_formats/jsonline.html
Related issue number
Checklist
docs/changelog/next_release/<pull request or issue id>.<change type>.rstfile added describing change(see CONTRIBUTING.rst for details.)