docs: use JSDoc for compatible release specifier comment (#1113)

Amp-Thread-ID:
https://ampcode.com/threads/T-01a17443-b5b9-703c-8877-780650eae403

Co-authored-by: Amp <amp@ampcode.com>
This commit is contained in:
Kevin Stillhammer
2026-10-26 08:49:11 +01:00
committed by GitHub
co-authored by Amp
parent 9c7332190c
commit 2f29784424
+5 -3
View File
@@ -195,9 +195,11 @@ async function findHighestSatisfyingVersion(
return pep440Match; return pep440Match;
} }
// `~=` is the PEP 440 compatible release operator. semver accepts it as a /**
// tilde range with a narrower upper bound (`~=0.5` as `<0.6.0` instead of * `~=` is the PEP 440 compatible release operator. semver accepts it as a
// `<1.0`), so it must only be evaluated as PEP 440. * tilde range with a narrower upper bound (`~=0.5` as `<0.6.0` instead of
* `<1.0`), so it must only be evaluated as PEP 440.
*/
function isCompatibleReleaseSpecifier(versionSpecifier: string): boolean { function isCompatibleReleaseSpecifier(versionSpecifier: string): boolean {
return versionSpecifier.includes("~="); return versionSpecifier.includes("~=");
} }