Update the documentation

cedx · Jan 24, 2024 · 063c997 · 063c997
1 parent 104c180
commit 063c997
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 13 deletions.
diff --git a/bin/setup_ant.cjs b/bin/setup_ant.cjs
diff --git a/docs/api/assets/search.js b/docs/api/assets/search.js
diff --git a/docs/api/classes/Setup.html b/docs/api/classes/Setup.html
diff --git a/docs/usage/inputs.md b/docs/usage/inputs.md
@@ -7,11 +7,11 @@ The version constraint of Apache Ant (optional, defaults to `latest`).
 Allowed values are:
 
 - `latest` or `*`: the latest stable release.
-- a loose version number: `1.0.0`, `1.10.0`, etc. It's equivalent to the caret `^` operator: `^1.0.0`, `^1.10.0`, etc.
-- a strict version number: `=1.0.0`, `=1.10.0`, etc.
+- a loose version number: `^1.0.0`, `~1.10.0`, etc.
+- a strict version number: `1.0.0`, `=1.10.0`, etc.
 - a version specification: `1.10.x`, `>=1.0.0 <1.10.0`, `=1.0.0 || ^1.10.0`, etc.
 
-> The version constraint follows the syntax and semantics of the [tink_semver](https://github.com/haxetink/tink_semver) library.
+> The version constraint follows the syntax and semantics of the [semver](https://www.npmjs.com/package/semver) package.
 
 ## **optional-tasks**: boolean
 By default, the external libraries required by each of the [optional tasks](https://ant.apache.org/manual/install.html#optionalTasks) are not installed.

diff --git a/src/setup.ts b/src/setup.ts
@@ -32,7 +32,7 @@ export class Setup {
 	async download(optionalTasks = false): Promise<string> {
 		const path = await extractZip(await downloadTool(this.release.url.href));
 		const directory = join(path, await this.#findSubfolder(path));
-		if (optionalTasks) await this.fetchOptionalTasks(directory);
+		if (optionalTasks) await this.#fetchOptionalTasks(directory);
 		return directory;
 	}
 
@@ -58,7 +58,7 @@ export class Setup {
 	 * @param antHome The path to the Ant directory.
 	 * @returns Resolves when the optional tasks have been fetched.
 	 */
-	fetchOptionalTasks(antHome: string): Promise<unknown> {
+	#fetchOptionalTasks(antHome: string): Promise<unknown> {
 		return promisify(exec)("ant -buildfile fetch.xml -noinput -silent -Ddest=system", {cwd: antHome, env: {ANT_HOME: antHome}});
 	}