From df43b0a58add54d197decde1a4b1b214d7653c74 Mon Sep 17 00:00:00 2001 From: ematipico Date: Tue, 1 Nov 2022 08:56:20 +0000 Subject: [PATCH] chore: better wording --- editors/vscode/configuration_schema.json | 2 +- npm/backend-jsonrpc/src/workspace.ts | 2 +- website/src/_includes/docs/post-installation.md | 3 ++- website/src/_includes/docs/reference.md | 4 +++- 4 files changed, 7 insertions(+), 4 deletions(-) diff --git a/editors/vscode/configuration_schema.json b/editors/vscode/configuration_schema.json index 2dbf7e2a7067..130227fa548d 100644 --- a/editors/vscode/configuration_schema.json +++ b/editors/vscode/configuration_schema.json @@ -515,7 +515,7 @@ "type": "object", "properties": { "maxSize": { - "description": "The maximum allowed size for source code files in bytes. Files above this limit will be ignore for performance reason. Defaults to 1 MiB", + "description": "The maximum allowed size for source code files in bytes. Files above this limit will be ignored for performance reason. Defaults to 1 MiB", "default": null, "type": [ "integer", diff --git a/npm/backend-jsonrpc/src/workspace.ts b/npm/backend-jsonrpc/src/workspace.ts index cb979ec8e65e..aab4a9342e94 100644 --- a/npm/backend-jsonrpc/src/workspace.ts +++ b/npm/backend-jsonrpc/src/workspace.ts @@ -49,7 +49,7 @@ export interface Configuration { */ export interface FilesConfiguration { /** - * The maximum allowed size for source code files in bytes. Files above this limit will be ignore for performance reason. Defaults to 1 MiB + * The maximum allowed size for source code files in bytes. Files above this limit will be ignored for performance reason. Defaults to 1 MiB */ maxSize?: number; } diff --git a/website/src/_includes/docs/post-installation.md b/website/src/_includes/docs/post-installation.md index 1237c0754307..1877847a27c0 100644 --- a/website/src/_includes/docs/post-installation.md +++ b/website/src/_includes/docs/post-installation.md @@ -4,4 +4,5 @@ Success! You're now ready to use Rome. 🥳 Check how to use the [formatter](#formatter), or the how to [lint](#linter) your project. -Read the [documentation](/docs) to learn more about supported commands and options. +Check the [reference](#reference) to learn more about the CLI and its supported commands/argument, or +the configuration file diff --git a/website/src/_includes/docs/reference.md b/website/src/_includes/docs/reference.md index f6f3b5e80169..fb81f7ededac 100644 --- a/website/src/_includes/docs/reference.md +++ b/website/src/_includes/docs/reference.md @@ -70,7 +70,9 @@ Prints the help message and exits. ### Configuration -#### `files.maxSize` +#### Files + +##### `files.maxSize` The maximum allowed size for source code files in bytes. Files above this limit will be ignored for performance reason.