docs(core): document std requirement and filesystem feature flag#551
docs(core): document std requirement and filesystem feature flag#551
Conversation
There was a problem hiding this comment.
Pull request overview
Documents that agnix-core requires std regardless of whether the filesystem feature is enabled, addressing confusion for downstream crates (e.g., WASM consumers) that use default-features = false.
Changes:
- Add a crate-level docs note in
lib.rsclarifyingstdis required andfilesystemdoes not implyno_std. - Add a “Feature Flags” section to
crates/agnix-core/README.mddocumenting thefilesystemfeature andstdrequirement. - Add a clarifying comment above
[features]incrates/agnix-core/Cargo.tomldescribing whatfilesystemcontrols.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| crates/agnix-core/src/lib.rs | Adds crate-level documentation clarifying unconditional std requirement and the meaning of filesystem. |
| crates/agnix-core/README.md | Documents feature flags, including filesystem defaults and how default-features = false affects dependencies (not std). |
| crates/agnix-core/Cargo.toml | Adds an inline note above [features] to prevent misinterpreting feature toggles as no_std support. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Document the new crate-level and README documentation clarifying that agnix-core requires std unconditionally and filesystem feature flag does not enable no_std support for WASM consumers.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
.github/workflows/security.yml
Outdated
| [versions] | ||
| patched = [">= 0.3.47"] | ||
| unaffected = ["< 0.3.6"] | ||
| \`\`\` |
There was a problem hiding this comment.
This workaround for the CVSS 4.0 parsing issue in cargo-audit is unrelated to the PR's purpose of documenting the std requirement. This change should be in a separate PR focused on fixing the CI security workflow.
Additionally, line 62 contains escaped backticks (```) which will literally appear in the generated advisory file. The escape sequences should be removed - the heredoc EOF delimiter will preserve the literal backticks without escaping.
| \`\`\` |
8c3c77c to
44d573b
Compare
Summary
Cargo.tomlabove[features]notingstdis required unconditionallycrates/agnix-core/README.mddocumenting thefilesystemfeature andstdrequirementstdrequirement note to crate-level doc comment inlib.rsTest plan
cargo checkpassescargo testpasses (all agnix-core tests)Closes #485