docs(changelog): correct from_rules entry — removed, not deprecated - #324
Merged
Conversation
`mds::LintConfig::from_rules` was removed in commit 339df37 (PR #308); it was never present in a published release. The [Unreleased] Deprecated entry was wrong on both counts. Move it to Removed, rewrite it as a removal notice, and drop the migration instructions — there is nothing to migrate from since no published version ever exposed the function. Co-Authored-By: Claude <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.
Summary
CHANGELOG.mdlines 1074–1082 placedmds::LintConfig::from_rulesunder a### Deprecatedheading, stating it was "deprecated in favor offrom_rules_checked" and providing migration instructions. The function does notexist on
main:grep "pub fn from_rules" crates/mds-core/src/lint/config.rsreturns only
from_rules_checked. The function was removed in commit339df37(PR #308). This fix corrects the record before the v0.4.0 tag makes the release
notes permanent.
Changes
from_rulesentry from### Deprecated(lines 1074–1082).### Removedentry stating the function was removed in PR v0.4.0 Wave 1: breaking changes, live-bug fixes, and release-safety gates #308 andwas never present in a published release (
crates/mds-core/src/lint/config.rsdid not exist at
v0.3.0; verified withgit show v0.3.0:crates/mds-core/src/lint/config.rs→ fatal: path … not in'v0.3.0'). No migration instructions are included — there is nothing to migrate
from because no published version ever exposed the function.
Breaking Changes
None. This is a release-notes accuracy fix, not a breaking-change disclosure.
from_ruleswas never shipped, so no real consumer can be affected.Reviewer Focus Areas
from_rulesis absent:grep "pub fn from_rules" crates/mds-core/src/lint/config.rsshould return only
from_rules_checked.node scripts/verify-no-control-bytes.mjs,npm run test:gates,node scripts/verify-versions.mjs.Why now
Release notes are permanent once a version tag is pushed. This is being fixed on
the
fix/changelog-from-rulesbranch and merged before the v0.4.0 tag so that thepublished notes are accurate from the start.