docs: align typing and lazy-logging examples with enforced ruff policy - #32776
Conversation
|
Hi there 👋 Thanks for your contribution! The OpenMetadata team will review the PR shortly! Once it has been labeled as Let us know if you need any help! |
✅ Playwright Results — workflow succeededValidated commit ✅ 557 passed · ❌ 0 failed · 🟡 0 flaky · ⏭️ 0 skipped · 🧰 0 lifecycle flaky PerformanceBlocking 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:
How to debug locally# Download playwright-test-results-<shard> artifact and unzip
npx playwright show-trace path/to/trace.zip # view trace |
Describe your changes:
Updated six living docs whose Python snippets still showed the old
Optional[T]/Union[A, B]/List[X]typing style and G004logger.warning(f"...")patterns. These snippets now match thecodebase (post-modernization) and the enforced ruff policy that forbids
UP006/UP007/UP035/UP045andG004suppressions viacheck_ruff_suppressions.py.Type of change:
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.mdwould copydescription: Optional[str] = Field(None, alias=...)into a newconnector, then fail
make py_format_checkwith an unsuppressibleUP045error and no documented way forward.Introduced by commit 31fe2b1 (@IceS2, #31643)
Doc Drift PRs can be configured here.