Skip to content

Commit

Permalink
docs: add missing periods (#124)
Browse files Browse the repository at this point in the history
  • Loading branch information
ComradeVanti authored Jan 17, 2024
1 parent 725fdb9 commit 0926dc8
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 22 deletions.
2 changes: 1 addition & 1 deletion src/cmd-login.ts
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ export const login = async function (
type LoginResult = { code: 0; token: string } | { code: 1 };

/**
* Return npm login token
* Return npm login token.
*/
const npmLogin = async function (
username: string,
Expand Down
2 changes: 1 addition & 1 deletion src/output-formatting.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ type TableablePackument = Pick<UnityPackument, "name" | "time" | "date"> &
/**
* Formats an array of packuments as a table. The table is returned
* as a single string (Includes line breaks).
* @param packuments The packuments
* @param packuments The packuments.
*/
export function formatAsTable(packuments: TableablePackument[]): string {
const table = new Table({
Expand Down
22 changes: 11 additions & 11 deletions src/registry-client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -110,10 +110,10 @@ export const getNpmClient = (): NpmClient => {
};

/**
* Fetch package info json from registry
* @param registry The registry from which to get the packument
* @param name The name of the packument
* @param client The client to use for fetching
* Fetch package info json from registry.
* @param registry The registry from which to get the packument.
* @param name The name of the packument.
* @param client The client to use for fetching.
*/
export const fetchPackument = async function (
registry: Registry,
Expand All @@ -129,13 +129,13 @@ export const fetchPackument = async function (
};

/**
* Fetch package dependencies
* @param registry The registry in which to search the dependencies
* @param upstreamRegistry The upstream registry in which to search as a backup
* @param name The name of the package
* @param version The version for which to search dependencies
* @param deep Whether to search for all dependencies
* @param client The client to use for communicating with the registries
* Fetch package dependencies.
* @param registry The registry in which to search the dependencies.
* @param upstreamRegistry The upstream registry in which to search as a backup.
* @param name The name of the package.
* @param version The version for which to search dependencies.
* @param deep Whether to search for all dependencies.
* @param client The client to use for communicating with the registries.
*/
export const fetchPackageDependencies = async function (
registry: Registry,
Expand Down
2 changes: 1 addition & 1 deletion src/types/project-manifest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ export function addTestable(manifest: UnityProjectManifest, name: DomainName) {
/**
* Determines the path to the package manifest based on the project
* directory.
* @param projectPath The root path of the Unity project
* @param projectPath The root path of the Unity project.
*/
export function manifestPathFor(projectPath: string): string {
return path.join(projectPath, "Packages/manifest.json");
Expand Down
16 changes: 8 additions & 8 deletions test/setup/unity-project.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ import { saveUpmConfig } from "../../src/utils/upm-config-io";
import {createProjectVersionTxt} from "../../src/utils/project-version-io";

/**
* A mock Unity project for testing
* A mock Unity project for testing.
*/
export type MockUnityProject = {
/**
* The path to the projects root folder
* The path to the projects root folder.
*/
projectPath: string;

Expand All @@ -38,12 +38,12 @@ export type MockUnityProject = {
tryAssertManifest(assertFn: (manifest: UnityProjectManifest) => void): void;

/**
* Resets the mock-project to its original state
* Resets the mock-project to its original state.
*/
reset(): Promise<void>;

/**
* Deletes the mock-project
* Deletes the mock-project.
*/
restore(): Promise<void>;
};
Expand All @@ -57,19 +57,19 @@ const defaultUpmConfig = {} satisfies UPMConfig;
type Config = {
/**
* The version to use for the project.
* If not specified uses {@link defaultVersion}
* If not specified uses {@link defaultVersion}.
*/
version?: string;
/**
* The manifest to use for the project.
* If not specified uses {@link defaultManifest}.
* If {@link false} no manifest is created
* If {@link false} no manifest is created.
*/
manifest?: UnityProjectManifest | false;

/**
* Override for the generated .upmconfig.toml.
* If not specified uses {@link defaultUpmConfig}
* If not specified uses {@link defaultUpmConfig}.
*/
upmConfig?: UPMConfig;
};
Expand All @@ -86,7 +86,7 @@ const projectPath = path.join(rootPath, "Project");
* - Clear {@link process.env.USERPROFILE}.
* - Change {@link process.env.HOME} to {@link rootPath}.
* - Place a .upmconfig.toml in the root folder of the test directory structure.
* @param config Config describing the project to be setup
* @param config Config describing the project to be setup.
*/
export async function setupUnityProject(
config: Config
Expand Down

0 comments on commit 0926dc8

Please sign in to comment.