Document 0.7 contract annotations - #907
Merged
Gudge (MGudgin) merged 1 commit intoAug 14, 2026
Merged
Conversation
This PR documents the annotation fields exposed by the published 0.7 configuration contract. Details * Document the optional `$schema` editor-validation reference. * Document the ignored `_comment` annotation value. Tests * `cargo fmt --all -- --check` * `$env:RUSTDOCFLAGS='-D missing-docs'; cargo doc -p mxc_config_contract --no-deps` * `cargo test -p mxc_config_contract` (175 tests passed) * `cargo clippy -p mxc_config_contract --all-targets -- -D warnings` Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
8 tasks
|
Azure Pipelines: There may be pipelines that require an authorized user to comment /azp run to run. |
Gudge (MGudgin)
changed the title
Contributor
There was a problem hiding this comment.
Pull request overview
Documents the published 0.7.0-alpha contract annotations for strict rustdoc validation.
Changes:
- Documents
$schemaeditor validation. - Documents ignored
_commentannotations.
Show a summary per file
| File | Description |
|---|---|
src/core/mxc_config_contract/src/published/v0_7_0_alpha/request.rs |
Adds rustdoc for annotation fields. |
Review details
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
- Files reviewed: 1/1 changed files
- Comments generated: 0
- Review effort level: Balanced
Branden Bonaby (bbonaby)
approved these changes
Aug 14, 2026
Gudge (MGudgin)
deleted the
user/gudge/version_specific_config_parsers_phase4_1
branch
August 14, 2026 20:08
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.
Document 0.7 contract annotations
This PR documents the annotation fields exposed by the published
0.7.0-alphaconfiguration contract.Details
$schemaeditor-validation reference._commentannotation value.missing_docsrustdoc build.Tests
cargo fmt --all -- --check$env:RUSTDOCFLAGS='-D missing-docs'; cargo doc -p mxc_config_contract --no-depscargo test -p mxc_config_contract(175 tests passed)cargo clippy -p mxc_config_contract --all-targets -- -D warningsgit diff --checkMicrosoft Reviewers: Open in CodeFlow