Skip to content

docs: align typing and lazy-logging examples with enforced ruff policy - #32776

Open
detail-app[bot] wants to merge 1 commit into
mainfrom
detail/fix-docs/docs-align-typing-and-lazy-logging-examples-with-e-ce10dc
Open

docs: align typing and lazy-logging examples with enforced ruff policy#32776
detail-app[bot] wants to merge 1 commit into
mainfrom
detail/fix-docs/docs-align-typing-and-lazy-logging-examples-with-e-ce10dc

Conversation

@detail-app

@detail-app detail-app Bot commented Sep 6, 2026

Copy link
Copy Markdown

Describe your changes:

Updated six living docs whose Python snippets still showed the old
Optional[T] / Union[A, B] / List[X] typing style and G004
logger.warning(f"...") patterns. These snippets now match the
codebase (post-modernization) and the enforced ruff policy that forbids
UP006/UP007/UP035/UP045 and G004 suppressions via
check_ruff_suppressions.py.

Type of change:

  • Documentation

High-level design:

N/A — small change.

Tests:

Not applicable — documentation only.

UI screen recording / screenshots:

Not applicable.

Example impact:

A contributor following code_style.md would copy
description: Optional[str] = Field(None, alias=...) into a new
connector, then fail make py_format_check with an unsuppressible
UP045 error and no documented way forward.

Introduced by commit 31fe2b1 (@IceS2, #31643)


Doc Drift PRs can be configured here.

@detail-app
detail-app Bot requested a review from IceS2 September 6, 2026 23:52
@github-actions

github-actions Bot commented Sep 6, 2026

Copy link
Copy Markdown
Contributor

Hi there 👋 Thanks for your contribution!

The OpenMetadata team will review the PR shortly! Once it has been labeled as safe to test, the CI workflows
will start executing and we'll be able to make sure everything is working as expected.

Let us know if you need any help!

@github-actions

github-actions Bot commented Sep 6, 2026

Copy link
Copy Markdown
Contributor

✅ Playwright Results — workflow succeeded

Validated commit f27d38599bd6ec77b1e7b6fd6ed5a12efd2b20a3 in Playwright run 34069266052, attempt 1.

✅ 557 passed · ❌ 0 failed · 🟡 0 flaky · ⏭️ 0 skipped · 🧰 0 lifecycle flaky

Performance

Blocking targets: ✅ met · Optimization targets: 🟡 in progress

Shard-job maxima below are not the full workflow wall time; the linked run includes build, fixture, planning, and reporting.

🕒 Full workflow signal wall (to summary) 35m 56s

⏱️ Max setup 4m 49s · max shard execution 19m 15s · max shard-job elapsed before upload 22m 42s · reporting 4s

🌐 234.81 requests/attempt · 2.82 app boots/UI scenario · 12.29% common-shard skew

Optimization targets still in progress:

  • Browser traffic was 234.81 requests per attempt (convergence target: fewer than 200).
  • Application boot ratio was 2.82 per UI scenario (1629 boots / 578 scenarios; convergence target: at most 1).
Shard Passed Failed Flaky Skipped Lifecycle failed Lifecycle flaky
✅ Shard chromium-01 135 0 0 0 0 0
✅ Shard chromium-02 135 0 0 0 0 0
✅ Shard chromium-03 129 0 0 0 0 0
✅ Shard data-asset-rules-01 65 0 0 0 0 0
✅ Shard domain-isolation-01 16 0 0 0 0 0
✅ Shard global-state-01 34 0 0 0 0 0
✅ Shard ingestion-01 1 0 0 0 0 0
✅ Shard reindex-01 2 0 0 0 0 0
✅ Shard search-01 11 0 0 0 0 0
✅ Shard search-rbac-01 29 0 0 0 0 0

📦 Download artifacts

How to debug locally
# Download playwright-test-results-<shard> artifact and unzip
npx playwright show-trace path/to/trace.zip    # view trace

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

safe to test Add this label to run secure Github workflows on PRs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant