Skip to content

[DOP-22432] Improve CSV documentation#358

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

[DOP-22432] Improve CSV documentation#358
dolfinus merged 1 commit intodevelopfrom
improvement/DOP-22432

Conversation

@dolfinus
Copy link
Member

@dolfinus dolfinus commented Mar 17, 2025

Change Summary

Previously CSV class 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/csv.html

After:
https://onetl--358.org.readthedocs.build/en/358/file_df/file_formats/csv.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 force-pushed the improvement/DOP-22432 branch from 80015c3 to 3808bcf Compare March 17, 2025 11:17
@dolfinus dolfinus force-pushed the improvement/DOP-22432 branch from 3808bcf to d7ff252 Compare March 17, 2025 11:25
@dolfinus dolfinus force-pushed the improvement/DOP-22432 branch from d7ff252 to a6c45de Compare March 17, 2025 11:28
@dolfinus dolfinus force-pushed the improvement/DOP-22432 branch from a6c45de to 8abe178 Compare March 17, 2025 11:28
@dolfinus dolfinus force-pushed the improvement/DOP-22432 branch from 8abe178 to 9a0bb2f Compare March 17, 2025 11:48
@dolfinus dolfinus force-pushed the improvement/DOP-22432 branch from 9a0bb2f to 783fe7b Compare March 17, 2025 12:01
@codecov
Copy link

codecov bot commented Mar 17, 2025

Codecov Report

Attention: Patch coverage is 98.70130% with 1 line in your changes missing coverage. Please review.

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

Files with missing lines Patch % Lines
onetl/file/format/file_format.py 50.00% 1 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #358      +/-   ##
===========================================
+ Coverage    92.50%   92.54%   +0.04%     
===========================================
  Files          229      229              
  Lines        10021    10079      +58     
  Branches      1016     1015       -1     
===========================================
+ Hits          9270     9328      +58     
  Misses         562      562              
  Partials       189      189              

☔ 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 12:12
@dolfinus dolfinus force-pushed the improvement/DOP-22432 branch from 783fe7b to 4fbe460 Compare March 17, 2025 13:27
@dolfinus dolfinus force-pushed the improvement/DOP-22432 branch from 4fbe460 to d300f95 Compare March 17, 2025 13:30
@dolfinus dolfinus merged commit d52059d into develop Mar 18, 2025
35 checks passed
@dolfinus dolfinus deleted the improvement/DOP-22432 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