Correct stale deprecation versions in API comments#9290
Conversation
b790d06 to
c7a4d63
Compare
dassaf4
left a comment
There was a problem hiding this comment.
core-geometry looks good, thanks.
|
are there any other incorrect deprecated in version comments than just the ones in here? |
|
What's the best practice for inserting the right deprecation version? Or is this automatic going forward? |
We've fixed all the currently-audited stale incorrect deprecation-version comments attributable to the 5.1.9 hardcoded policy problem. If there are any other incorrect deprecated version comments, that would come from human error, manually written deprecation comments disclosing which major/minor/patch versions are not affected by this problem - in that case, that should be part of a different PR if we had any remaining, but that'll be more fine combing through the repo |
I would defer to my senior colleagues to answer, I'm sure knowing what could happen I will be manually stamping which version I deprecate my apis 😃 |
Closes #9287
Why
Some deprecated API comments are still stamped as
@deprecated in 5.1.9even when the replacement API was introduced later in5.5.0or5.9.0. That leaves users with the wrong migration timeline in editor warnings and generated docs, and it makes the deprecation metadata inconsistent with the actual history we already traced.This PR manually corrects the already-triaged stale comments so the published deprecation guidance matches the release where those APIs were actually deprecated. It is intentionally separate from the pipeline fix that restores version syncing for future deprecation rewrites.
What
core/backenddeprecation comment updates5.1.9deprecations live here, so these edits realign backend API comments with the actual5.9.0deprecation wave and its existing removal-date buckets.core/commonandcore/frontenddeprecation comment updates5.1.9, so they now match the same5.9.0migration timeline as the backend APIs they pair with.domains/linear-referencing/backenddeprecation comment updates5.9.0version.core/geometrydeprecation comment updates5.5.0, so they need a separate version correction instead of being lumped into the5.9.0bucket.No runtime behavior changed; this is a comment-only cleanup of stale deprecation metadata across 28 files.
Validation
node common/scripts/install-run-rush.js install --bypass-policynode common/scripts/install-run-rush.js build --to @itwin/core-backend --to @itwin/core-common --to @itwin/core-frontend --to @itwin/core-geometry --to @itwin/linear-referencing-backendcd core/geometry && node ../../common/scripts/install-run-rushx.js docscd core/common && node ../../common/scripts/install-run-rushx.js docscd core/backend && node ../../common/scripts/install-run-rushx.js docscd core/frontend && node ../../common/scripts/install-run-rushx.js docscd domains/linear-referencing/backend && node ../../../common/scripts/install-run-rushx.js docsnode common/scripts/install-run-rush.js extract-api --to @itwin/core-backend --to @itwin/core-common --to @itwin/core-frontend --to @itwin/core-geometry --to @itwin/linear-referencing-backendrg -n "@deprecated in 5\.1\.9" core presentation domains editor extensions tools ui utils full-stack-tests common→ no matches in the targeted source roots after the cleanupNambot 🤖 (powered by gpt-5.4)