Skip to content

fix(docs): simplify tolerance docstring examples in check_funcs.py#1254

Merged
mwojtyczka merged 2 commits into
databrickslabs:mainfrom
neeraj-bhadani-08:fix-doc-string
Jun 24, 2026
Merged

fix(docs): simplify tolerance docstring examples in check_funcs.py#1254
mwojtyczka merged 2 commits into
databrickslabs:mainfrom
neeraj-bhadani-08:fix-doc-string

Conversation

@neeraj-bhadani-08

@neeraj-bhadani-08 neeraj-bhadani-08 commented Jun 17, 2026

Copy link
Copy Markdown
Contributor

Changes

Summary

  • Simplified abs_tolerance and rel_tolerance docstring examples in is_equal_to, is_not_equal_to, compare_datasets, and _add_column_diffs to use inline prose instead of multi-line indented blocks.
  • Replaced Example: with For example, compare_datasets, and _add_column_diffs to use inline prose instead of multi-line indented blocks.

Tests

  • manually tested

Before change

Screenshot 2026-05-29 at 11 29 32

After change

Screenshot 2026-06-17 at 11 53 08

@neeraj-bhadani-08 neeraj-bhadani-08 requested a review from a team as a code owner June 17, 2026 10:55
@neeraj-bhadani-08 neeraj-bhadani-08 requested review from tombonfert and removed request for a team June 17, 2026 10:55
@github-actions

Copy link
Copy Markdown
Contributor

All commits in PR should be signed ('git commit -S ...'). See https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits

@CLAassistant

CLAassistant commented Jun 17, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@mwojtyczka

mwojtyczka commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

@neeraj-bhadani-08 thank you for the PR. Before we merge you need to sign the commits so that they are verified. We won't be able to accept the PR otherwise:

Generate gpg key and repush the commits:

git reset --soft $(git merge-base origin/main HEAD)  # point to the common ancestor of main and your branch
#git reset --soft HEAD~<how-many-commit-go-back>  # alternatively, specify how many commits to go back
git commit -S --reuse-message=ORIG_HEAD
git push --force-with-lease origin HEAD

See: https://databrickslabs.github.io/dqx/docs/dev/contributing/#first-contribution

@mwojtyczka mwojtyczka left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - but you need to sign commits before we can merge

@mwojtyczka mwojtyczka added the Approved to Merge When PR is reviewed and approved. To be merged once all tests pass label Jun 23, 2026

@mwojtyczka mwojtyczka left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@mwojtyczka

Copy link
Copy Markdown
Contributor

@neeraj-bhadani-08 i repushed your commit to have them signed. For future PRs, you need to sign commits with your GPG key. To set up GPG key in your Github account, follow these instructions. You can configure Git to sign all commits with your GPG key by default: git config --global commit.gpgsign true You can do the same in your IDE if you use git integration functionalities.

More here: https://databrickslabs.github.io/dqx/docs/dev/contributing/#first-contribution

@mwojtyczka mwojtyczka merged commit c98da6c into databrickslabs:main Jun 24, 2026
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Approved to Merge When PR is reviewed and approved. To be merged once all tests pass documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants