Skip to content

[DOP-22433] Improve JSON/JSONLine documentation#359

Merged
dolfinus merged 1 commit intodevelopfrom
improvement/DOP-22433
Mar 18, 2025
Merged

[DOP-22433] Improve JSON/JSONLine documentation#359
dolfinus merged 1 commit intodevelopfrom
improvement/DOP-22433

Conversation

@dolfinus
Copy link
Member

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

  • Commit message and PR title is comprehensive
  • Keep the change as small as possible
  • Unit and integration tests for the changes exist
  • Tests pass on CI and coverage does not decrease
  • Documentation reflects the changes where applicable
  • docs/changelog/next_release/<pull request or issue id>.<change type>.rst file added describing change
    (see CONTRIBUTING.rst for details.)
  • My PR is ready to review.

@dolfinus dolfinus added the ci:skip-changelog Add this label to skip changelog file check label Mar 17, 2025
@dolfinus dolfinus self-assigned this Mar 17, 2025
@dolfinus dolfinus force-pushed the improvement/DOP-22433 branch from ddce800 to a9cc05d Compare March 17, 2025 13:17
@dolfinus dolfinus changed the title Improvement/dop 22433 [DOP-22433] Improve JSON/JSONLine documentation Mar 17, 2025
@dolfinus dolfinus force-pushed the improvement/DOP-22433 branch from a9cc05d to 3a77761 Compare March 17, 2025 13:22
@dolfinus dolfinus force-pushed the improvement/DOP-22433 branch from 3a77761 to 84150c3 Compare March 17, 2025 13:27
@codecov
Copy link

codecov bot commented Mar 17, 2025

Codecov Report

Attention: Patch coverage is 95.79832% with 5 lines in your changes missing coverage. Please review.

Project coverage is 92.54%. Comparing base (39881c8) to head (7405e2d).
Report is 30 commits behind head on develop.

Files with missing lines Patch % Lines
onetl/file/format/json.py 96.77% 2 Missing ⚠️
onetl/file/format/jsonline.py 96.36% 2 Missing ⚠️
onetl/file/format/file_format.py 50.00% 1 Missing ⚠️
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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@dolfinus dolfinus marked this pull request as ready for review March 17, 2025 13:52
@dolfinus dolfinus merged commit cc25dd1 into develop Mar 18, 2025
35 checks passed
@dolfinus dolfinus deleted the improvement/DOP-22433 branch March 18, 2025 07:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci:skip-changelog Add this label to skip changelog file check

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants