docs(features): fix self_update probability + nightly sub-features#3833
Merged
Conversation
The `self_update` blurb claimed it checks GitHub 10% of the time on startup. Code (src/main.rs) actually rolls 50% and only when qsv is invoked with no command. The `nightly` blurb listed crates without naming the actual sub-features enabled (rand/simd_support, simd-json/hints, etc.) — clarified to match Cargo.toml. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
[skip ci]
Up to standards ✅🟢 Issues
|
Contributor
There was a problem hiding this comment.
Pull request overview
Updates docs/FEATURES.md to reflect the current behavior and configuration of feature flags in the qsv codebase.
Changes:
- Corrected the
self_updatedocumentation to match actual update-check gating and probability. - Replaced the
nightlyfeature description with the concrete Cargo sub-feature mapping. - Converted the trailing NOTE into GitHub-flavored admonition syntax (
> [!NOTE]).
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.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
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
docs/FEATURES.mdsurfaced two factual drifts vs. code/Cargo.toml.self_updateblurb claimed it polls GitHub "10% of the time upon startup". Reality (src/main.rs): it rolls 50% and only whenqsvis invoked with no command (theNonearm of the command match).nightlyblurb listed crates without naming the actual sub-features enabled. Replaced the loose list with the concreteCargo.tomlmapping:crc32fast/nightly,pyo3/nightly,rand/simd_support,simd-json/hints,foldhash/nightly.> [!NOTE]syntax.Test plan
src/main.rsself-update probability is 50% and gated on no-command pathCargo.tomlnightlyfeature mappingdocs/ENVIRONMENT_VARIABLES.mdforQSV_NO_UPDATEconsistency (no drift)🤖 Generated with Claude Code