Skip to content

[DOP-22434] Improve ORC documentation#362

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

[DOP-22434] Improve ORC documentation#362
dolfinus merged 1 commit intodevelopfrom
improvement/DOP-22434-orc

Conversation

@dolfinus
Copy link
Member

Change Summary

Previously ORC 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/orc.html

After:
https://onetl--362.org.readthedocs.build/en/362/file_df/file_formats/orc.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
@codecov
Copy link

codecov bot commented Mar 17, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.52%. Comparing base (39881c8) to head (a9228ac).
Report is 30 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #362      +/-   ##
===========================================
+ Coverage    92.50%   92.52%   +0.01%     
===========================================
  Files          229      229              
  Lines        10021    10031      +10     
  Branches      1016     1017       +1     
===========================================
+ Hits          9270     9281      +11     
  Misses         562      562              
+ 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 16:43
@dolfinus dolfinus merged commit b9cd90c into develop Mar 18, 2025
36 of 37 checks passed
@dolfinus dolfinus deleted the improvement/DOP-22434-orc branch March 18, 2025 09:08
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