Skip to content

docs(python-setup): replace an internal tracker key with the actual reason - #2082

Merged
rugpanov merged 2 commits into
mainfrom
rugpanov/serverless-default-source-comment
Aug 6, 2026
Merged

docs(python-setup): replace an internal tracker key with the actual reason#2082
rugpanov merged 2 commits into
mainfrom
rugpanov/serverless-default-source-comment

Conversation

@rugpanov

@rugpanov rugpanov commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

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 used one to explain why the workspaceDefault version 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

- * selection; the scorer merges and de-dupes across sources. (The
- * workspace-default API source is not yet available — see <internal key>.)
+ * selection; the scorer merges and de-dupes across sources.
+ *
+ * The scorer also defines a `workspaceDefault` source, which is not
+ * collected here: it would come from the workspace's default base
+ * environment, and the SDK we depend on exposes no base-environment API yet.
+ * Until it does, that weight simply never contributes and the ranking falls
+ * back to the local sources.

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.md and src/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 --noEmit clean.
  • yarn test:lint clean (eslint + prettier).
  • Re-verified the claim before writing it: no BaseEnvironment type anywhere in the bundled SDK, so the API genuinely is unavailable rather than merely unused.
  • No unit run: the change cannot affect behaviour.

This pull request and its description were written by Isaac.

…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

rugpanov commented Aug 5, 2026

Copy link
Copy Markdown
Contributor Author

🤖 Integration tests ❌ 4 of 35 test jobs failed for 87a72eb1 (31 passed).
View run

@rugpanov
rugpanov enabled auto-merge (squash) August 6, 2026 08:25
@rugpanov
rugpanov temporarily deployed to test-trigger-is August 6, 2026 08:25 — with GitHub Actions Inactive
@rugpanov
rugpanov merged commit f8857c6 into main Aug 6, 2026
6 checks passed
@github-actions

github-actions Bot commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

If integration tests don't run automatically, an authorized user can run them manually by following the instructions below:

Trigger:
go/deco-tests-run/vscode

Inputs:

  • PR number: 2082
  • Commit SHA: 69a1627579fc23a0029d36badd1ce7e88eacd573

Checks will be approved automatically on success.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants