docs(python-setup): replace an internal tracker key with the actual reason - #2082
Merged
Conversation
…eason *Why* This repo is public, and an internal tracker key carries no information for the people who read the code here — they cannot open it. The comment on `collectServerlessObservations` pointed at one to explain why the `workspaceDefault` version source is missing, so the one fact a reader actually needs was only available to Databricks employees. The key was also stale: it named the ticket the source was deferred *from*, not the one now tracking it. Swapping in the newer key would have kept a reference that cannot be followed, so the reason is stated inline instead. *What* Replace the key with the technical cause: the scorer defines a `workspaceDefault` source that is not collected because the SDK we depend on exposes no base-environment API yet, and until it does that weight never contributes and ranking falls back to the local sources. Leaves the two other pre-existing mentions alone (`telemetry/README.md` and `unity_catalog.ucws.e2e.ts`); each needs its own call about what replaces it. *Verification* - Comment-only: no behaviour change, no source statement touched. - `yarn tsc --noEmit` clean; `yarn test:lint` clean (eslint + prettier). - Re-confirmed the claim before writing it: no `BaseEnvironment` type anywhere in the bundled SDK, so the API genuinely is unavailable. - `git grep "DECO-"` over `src/` now returns only the two mentions left deliberately out of scope. Co-authored-by: Isaac
rugpanov
temporarily deployed
to
test-trigger-is
August 5, 2026 15:00 — with
GitHub Actions
Inactive
rugpanov
temporarily deployed
to
test-trigger-is
August 5, 2026 15:00 — with
GitHub Actions
Inactive
rugpanov
requested a deployment
to
test-trigger-is
August 5, 2026 15:00 — with
GitHub Actions
Queued
Contributor
Author
|
🤖 Integration tests ❌ 4 of 35 test jobs failed for |
misha-db
approved these changes
Aug 5, 2026
rugpanov
enabled auto-merge (squash)
August 6, 2026 08:25
rugpanov
temporarily deployed
to
test-trigger-is
August 6, 2026 08:25 — with
GitHub Actions
Inactive
Contributor
|
If integration tests don't run automatically, an authorized user can run them manually by following the instructions below: Trigger: Inputs:
Checks will be approved automatically on success. |
rugpanov
temporarily deployed
to
test-trigger-is
August 6, 2026 08:26 — with
GitHub Actions
Inactive
rugpanov
requested a deployment
to
test-trigger-is
August 6, 2026 08:27 — with
GitHub Actions
Queued
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
This repo is public, and an internal tracker key carries no information for the people who read the code here — they cannot open it. The comment on
collectServerlessObservationsused one to explain why theworkspaceDefaultversion source is missing, so the single fact a reader actually needs was only available to Databricks employees.The key was also stale: it named the ticket the source was deferred from, not the one now tracking it. Swapping in the newer key would have kept a reference that cannot be followed, so the reason is stated inline instead — which gives a reader strictly more than either key did.
Follows the rule added in #2081.
What
The replacement states what is missing (
workspaceDefault), why (no base-environment API in the pinned SDK), and what it means in practice (that weight never contributes; the local bundle/notebook sources decide the ranking).Scope
Comment-only — one doc comment, no source statement touched.
The two other pre-existing internal-key mentions (
src/telemetry/README.mdandsrc/test/e2e/unity_catalog.ucws.e2e.ts) are deliberately left alone. Each needs its own judgement call about what replaces it, and the e2e one in particular is a skipped test where dropping the only tracker link deserves a separate decision.Tests
yarn tsc --noEmitclean.yarn test:lintclean (eslint + prettier).BaseEnvironmenttype anywhere in the bundled SDK, so the API genuinely is unavailable rather than merely unused.This pull request and its description were written by Isaac.