Improve in-code documentation for product asset graph#80
Merged
Conversation
- products.py: refresh stale module docstring (now covers the geoserver publish asset + GeoPackage flow and the ASCII graph), document all three asset builders and build_product_assets, explain _in_name sanitization, drop an unused is_summary local in the source-asset builder. - die_config.py: document get_config's products.yaml -> Config mapping and flag that the include-list source list must track backend SOURCE_KEYS. Docs/comments only; no behavior change. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
Your pull request is automatically being deployed to Dagster Cloud.
|
Declare the Dagster dg CLI project layout: root pyproject marks the repo as a dg project; orchestration/pyproject sets root_module=orchestration. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Document the dg-based workflow for Dagster operations (dev, list defs, launch), the product asset-graph architecture, validation via the import smoke test (dg check defs is currently blocked by a root_module layout mismatch), and the Dagster+ serverless deploy setup. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
dg resolves a local module as <project_root>/<module_parts> on disk. With the dg project at orchestration/ and root_module="orchestration", dg looked for orchestration/orchestration/ (nonexistent), so `dg check defs` failed and dg kept rewriting root_module to ".". The orchestration package lives at repo-root level (./orchestration/) — the same place the Dagster+ serverless build imports it from — so make the repo root the dg project with root_module="orchestration", which resolves to ./orchestration/. Remove the competing [tool.dg] block from orchestration/pyproject.toml. Suppress the venv-mismatch warning (dg runs via the orchestration venv through `uv run` while the project root is the repo root). `dg check defs` and `dg list defs` now succeed. Update AGENTS.md accordingly. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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
1 participant
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.
What
Documentation/comments only — no behavior change. Carries over the doc commit that landed on the #79 branch after that PR was merged.
Changes
orchestration/assets/products.py:_build_source_asset,_build_combine_asset,_build_geoserver_asset) andbuild_product_assets._in_name(combine-asset input kwargs must be valid Python identifiers).is_summarylocal in the source-asset builder (dead code found during review).orchestration/resources/die_config.py:get_config's products.yaml →Configmapping.backend.config.SOURCE_KEYS, or include-list products silently drop sources.Notes for reviewer
orchestration.definitionsstill imports/loads after the dead-code removal.🤖 Generated with Claude Code