Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOP-16174] Small documentation fixes #281

Merged
merged 1 commit into from
May 24, 2024
Merged

Conversation

dolfinus
Copy link
Member

@dolfinus dolfinus commented May 23, 2024

Change Summary

Few small fixes in documentation:

  • Docstrings for new classes ClickhouseReadOptions, ClickhouseWriteOptions and others were missing. Added a workaround.
  • Fix malformed tables in Clickhouse & Postgres Types documentation
  • Replace -> with
  • Use seealso directive instead of warning
  • Remove duplicated warning about DBReader usage, it is already described in DB connectors documentation.
  • Added links to exact package version in Maven.

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 May 23, 2024
@dolfinus dolfinus self-assigned this May 23, 2024
Copy link

codecov bot commented May 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.79%. Comparing base (22818a5) to head (4f583a3).
Report is 68 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #281      +/-   ##
===========================================
+ Coverage    94.77%   94.79%   +0.02%     
===========================================
  Files          210      210              
  Lines         8187     8187              
  Branches      1410     1410              
===========================================
+ Hits          7759     7761       +2     
+ Misses         305      304       -1     
+ Partials       123      122       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@dolfinus dolfinus merged commit 8a2cbd9 into develop May 24, 2024
46 checks passed
@dolfinus dolfinus deleted the feature/DOP-16174 branch May 24, 2024 07:31
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