Format Markdown with snapper#2
Open
nhorton wants to merge 1 commit into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
This PR applies snapper semantic line-break formatting across tracked Markdown documentation and skill guides in the SemLang packages repo.
Changes:
- Reflowed Markdown prose into semantic line breaks across docs, design docs, skills, and examples.
- Normalized long wrapped paragraphs into shorter single-sentence lines.
- Kept content largely unchanged while making formatting consistent for
snapper --check.
Reviewed changes
Copilot reviewed 34 out of 34 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
skills/semlang/SKILL.md |
Reformatted SemLang skill guide prose and lists. |
skills/semlang-setup/SKILL.md |
Reformatted SemLang setup workflow guide. |
skills/initial-ontology-creation/SKILL.md |
Reformatted initial ontology creation workflow guide. |
README.md |
Reformatted repository overview and install instructions. |
examples/saas-product-usage-and-revenue/about.md |
Reflowed example package description paragraphs. |
examples/retail-omnichannel-margin-and-returns/about.md |
Reflowed example package description paragraphs. |
examples/manufacturing-supply-chain-traceability-and-quality/about.md |
Reflowed example package description paragraphs. |
examples/healthcare-patient-journey-and-quality-measures/about.md |
Reflowed example package description paragraphs. |
examples/banking-credit-risk-and-customer-exposure/about.md |
Reflowed example package description paragraphs. |
docs/semlang-concepts.md |
Reflowed concepts modeling guidance text. |
docs/mcp-server/tools-overview.md |
Reflowed MCP tool overview text. |
docs/mcp-server/source-and-search.md |
Reflowed load_ontology / search documentation text. |
docs/mcp-server/reasoning-tools.md |
Reflowed reasoning workflow guidance text. |
docs/mcp-server/query-and-action-tools.md |
Reflowed run_query / invoke_action documentation text. |
docs/mcp-server/ontology-tools.md |
Reflowed describe / find_paths documentation text. |
docs/mcp-server/malloy-connections.md |
Reflowed Malloy connection naming/config guidance text. |
docs/mcp-server/lens-tools.md |
Reflowed lens discovery/inspection docs text. |
docs/mcp-server/index.md |
Reflowed MCP server landing page text. |
docs/mcp-server/configuration.md |
Reflowed configuration and setup docs text. |
docs/language-reference/supported_malloy_features.md |
Reflowed language-reference compatibility audit intro text. |
docs/language-reference/sources.md |
Reflowed sources reference text. |
docs/language-reference/schema-vocabulary.md |
Reflowed JSON Schema export/vocabulary docs text. |
docs/language-reference/lenses.md |
Reflowed lenses reference and examples narrative text. |
docs/language-reference/index.md |
Reflowed language reference landing page text. |
docs/language-reference/expressions.md |
Reflowed expressions reference narrative text. |
docs/language-reference/diagnostics-lowering.md |
Reflowed diagnostics/lowering narrative text. |
docs/language-reference/declarations.md |
Reflowed declarations reference narrative text. |
docs/language-reference/concepts.md |
Reflowed concepts reference narrative text. |
docs/language-reference/actions.md |
Reflowed actions reference narrative text. |
design-docs/supported_malloy_features.md |
Reflowed design-doc audit intro text. |
design-docs/semlang-vs-palantir.md |
Reflowed comparison doc narrative text. |
design-docs/language.md |
Reflowed language specification narrative text. |
design-docs/architecture.md |
Reflowed compiler architecture doc narrative text. |
design-docs/actions-requirements.md |
Reflowed actions requirements/checklist narrative text. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+19
to
+22
| - Every SemLang file starts with exactly one `package` declaration. | ||
| `include` declarations may follow the package and must come before sources, types, concepts, lenses, and queries. | ||
| - SemLang should compile to Malloy. | ||
| Do not invent syntax that cannot lower clearly. |
Comment on lines
+18
to
+24
| 2. Determine whether any inspected config already defines `mcpServers.semlang`. | ||
| 3. If a `semlang` MCP server already exists, summarize where it was found and do not add another server unless the user explicitly asks. | ||
| 4. If SemLang MCP is missing, propose adding project-local Pi config at `.pi/mcp.json`. | ||
| Prefer this Pi-owned project config unless an existing `.mcp.json` already has, or clearly should have, the SemLang config. | ||
| 5. Ask for user confirmation before creating or editing MCP config unless the user has already explicitly authorized the edit. | ||
| 6. Preserve existing MCP config contents. | ||
| Merge only the missing `mcpServers.semlang` entry and keep other servers/settings unchanged. |
Comment on lines
+16
to
+21
| - Start from the user's business domain and questions, not only from the physical schema. | ||
| - Treat existing documentation, data catalogs, ERDs, dbt docs, BI dashboards, metric definitions, tickets, and stakeholder notes as optional but high-value context. | ||
| - Preserve uncertainty. When a relationship, concept type, temporal grain, or metric meaning is inferred, mark it as inferred and validate it explicitly. | ||
| - When delegation is available and permitted, use a sub-agent for the data-connection and source-introspection work, then reuse that same sub-agent for the first-pass ontology creation. The calling agent should preserve context for user review, questions, and modeling decisions instead of spending it on the iterative mechanics of connection setup and bulk drafting. | ||
| - Preserve uncertainty. | ||
| When a relationship, concept type, temporal grain, or metric meaning is inferred, mark it as inferred and validate it explicitly. | ||
| - When delegation is available and permitted, use a sub-agent for the data-connection and source-introspection work, then reuse that same sub-agent for the first-pass ontology creation. | ||
| The calling agent should preserve context for user review, questions, and modeling decisions instead of spending it on the iterative mechanics of connection setup and bulk drafting. |
Comment on lines
+23
to
+25
| It preserves source locations and declaration structure. | ||
| - `SemanticModel`: the resolved package graph. | ||
| It indexes types, concepts, lenses, and queries by their compiler names. |
| For named queries, returns the resolved query, diagnostics, extracted `queryMalloy`, and an `execution` object. | ||
| For temporary queries, returns the generated query name, root, lenses, diagnostics, extracted `queryMalloy`, and `execution`. | ||
| When `dry_run_only` is true, `execution` is present with `skipped: true`, `execution.ok` is omitted, and `query_limit_seconds` is not required. | ||
| The full compiled Malloy model is not returned by `run_query`; request it from `load_ontology` with `return_malloy_model` when debugging the whole generated model. |
9567a55 to
7f75fd1
Compare
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.
Summary
Validation
git ls-files -z '*.md' | xargs -0 snapper --check && cd packages/semlang && git ls-files -z '*.md' | xargs -0 snapper --checknpm run check