Skip to content

Commit ad5bfae

Browse files
committed
Improve settings description grammar
1 parent 754cf05 commit ad5bfae

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

package.json

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -406,14 +406,14 @@
406406
"scope": "application",
407407
"default": true,
408408
"order": 2,
409-
"markdownDescription": "Updates and installs outdated or missing tools without user confirmation automatically."
409+
"markdownDescription": "Automatically update and install outdated or missing tools without user confirmation."
410410
},
411411
"d.showUpdateChangelogs": {
412412
"type": "boolean",
413413
"scope": "application",
414414
"default": true,
415415
"order": 3,
416-
"markdownDescription": "Opens `CHANGELOG.md` on every code-d update (which also includes serve-d updates) to see new features."
416+
"markdownDescription": "Open `CHANGELOG.md` on every code-d update (which also includes serve-d updates) to see new features."
417417
}
418418
}
419419
},
@@ -426,7 +426,7 @@
426426
"type": "boolean",
427427
"scope": "resource",
428428
"default": true,
429-
"markdownDescription": "Enables auto-completion in D files, mostly powered by DCD. To change which DCD binary to run as auto-completion server, use the `#d.dcdServerPath#` setting. (only needed if you want to use a custom DCD setup)"
429+
"markdownDescription": "Enable auto-completion in D files, mostly powered by DCD.\n\nIf you have a custom DCD setup, you can change the started dcd-server binary through the `#d.dcdServerPath#` setting."
430430
},
431431
"d.stdlibPath": {
432432
"scope": "machine-overridable",
@@ -507,13 +507,13 @@
507507
"type": "boolean",
508508
"scope": "resource",
509509
"default": false,
510-
"markdownDescription": "Inserts the function signature (function arguments) as snippet which can be navigated using tab when autocompleting functions."
510+
"markdownDescription": "Insert function signatures (function arguments) as snippets which can be navigated using tab when auto-completing functions."
511511
},
512512
"d.dietContextCompletion": {
513513
"type": "boolean",
514514
"scope": "resource",
515515
"default": false,
516-
"markdownDescription": "Enables reading `//-context=path/to/file.d` comments in diet files and act like the D code inside the diet file comes from there, to allow auto-completion of local symbols."
516+
"markdownDescription": "Read `//-context=path/to/file.d` comments in diet files and act like the D code inside the diet file comes from there, to allow auto-completion of local symbols."
517517
}
518518
}
519519
},
@@ -557,19 +557,19 @@
557557
"scope": "resource",
558558
"default": true,
559559
"order": 9,
560-
"markdownDescription": "Initializes isolated workspaces for every dub.sdl and dub.json file in all folders, avoiding mixing import paths in unrelated projects."
560+
"markdownDescription": "Initialize isolated workspaces for every dub.sdl and dub.json file in all folders, avoiding mixing import paths in unrelated projects."
561561
},
562562
"d.neverUseDub": {
563563
"type": "boolean",
564564
"scope": "resource",
565565
"default": false,
566-
"markdownDescription": "Disables DUB integration and requires you to always manually provide import paths. See `#d.projectImportPaths#` for setting import paths then. This is discouraged as it will remove most features like packages, building & compiler linting. If this is a standalone project with no external dependencies with a custom build system then this should be true."
566+
"markdownDescription": "Disable DUB integration and require manually provided import paths using `#d.projectImportPaths#`.\n\nThis is discouraged as it will remove most features like resolving dependencies, building and compiler linting. For standalone projects with no external dependencies with a custom build system then this can be useful."
567567
},
568568
"d.alwaysShowDubStatusButtons": {
569569
"type": "boolean",
570570
"scope": "resource",
571571
"default": false,
572-
"markdownDescription": "Always shows DUB Configuration/Arch Type/Build Type/Compiler buttons in DUB projects, and not just when a D file is open."
572+
"markdownDescription": "Always show DUB Configuration/Arch Type/Build Type/Compiler buttons in DUB projects, and not just when a D file is open."
573573
},
574574
"d.dependencyClickBehavior": {
575575
"type": "string",
@@ -629,28 +629,28 @@
629629
"type": "boolean",
630630
"scope": "resource",
631631
"default": true,
632-
"markdownDescription": "Enables 'squiggly lines' error diagnostics while editing source code.\n\nTurning this off disables all diagnostics coming from code-d.You can toggle\n\n- `#d.enableSDLLinting#`\n- `#d.enableDubLinting#`\n- `#d.enableStaticLinting#`\n\nfor finer control instead."
632+
"markdownDescription": "Enable errors and warnings (squiggly lines) while editing source code.\n\nTurning this off disables all diagnostics coming from code-d.You can toggle\n\n- `#d.enableSDLLinting#`\n- `#d.enableDubLinting#`\n- `#d.enableStaticLinting#`\n\nfor finer control instead."
633633
},
634634
"d.enableStaticLinting": {
635635
"order": 1,
636636
"type": "boolean",
637637
"scope": "resource",
638638
"default": true,
639-
"markdownDescription": "D files will be checked for errors, without being built, whenever typing.\n\nOnly has an effect if `#d.enableLinting#` is also turned on."
639+
"markdownDescription": "Check D file for errors and warnings, without being built, whenever typing.\n\nOnly has an effect if `#d.enableLinting#` is also turned on."
640640
},
641641
"d.enableDubLinting": {
642642
"order": 2,
643643
"type": "boolean",
644644
"scope": "resource",
645645
"default": true,
646-
"markdownDescription": "DUB projects will run the configured compiler on save to check for compile errors.\n\nThis is very similar to running `dub build` on the command line to see what actual errors occur, but does not output any executable or library.\n\nOnly has an effect if `#d.enableLinting#` is also turned on."
646+
"markdownDescription": "Compile DUB projects on save to check for compile errors.\n\nThis is very similar to running `dub build` on the command line to see what actual errors occur, but does not output any executable or library.\n\nOnly has an effect if `#d.enableLinting#` is also turned on."
647647
},
648648
"d.enableSDLLinting": {
649649
"order": 3,
650650
"type": "boolean",
651651
"scope": "resource",
652652
"default": true,
653-
"markdownDescription": "`dub.sdl` files will be checked for errors.\n\nOnly has an effect if `#d.enableLinting#` is also turned on."
653+
"markdownDescription": "Check `dub.sdl` files for errors and warnings.\n\nOnly has an effect if `#d.enableLinting#` is also turned on."
654654
},
655655
"d.lintOnFileOpen": {
656656
"type": "string",
@@ -739,13 +739,13 @@
739739
"type": "boolean",
740740
"scope": "resource",
741741
"default": true,
742-
"markdownDescription": "The standard VSCode Formatting behavior will apply to D files when on. Formatting on save can be configured with `#editor.formatOnSave#`"
742+
"markdownDescription": "Apply standard VSCode Formatting behavior to D files. Formatting on save can be configured with `#editor.formatOnSave#`"
743743
},
744744
"d.overrideDfmtEditorconfig": {
745745
"type": "boolean",
746746
"scope": "resource",
747747
"default": true,
748-
"markdownDescription": "Uses the VSCode `dfmt.*` config options & editor settings instead of `.editorconfig`. This avoids inconsistencies with the vscode editor settings, it's recommended to only turn this off when you have the EditorConfig extension for VSCode installed."
748+
"markdownDescription": "Use the VSCode `dfmt.*` config options & editor settings instead of `.editorconfig` files. This avoids inconsistencies with the vscode editor settings, it's recommended to only turn this off when you have the EditorConfig extension for VSCode installed."
749749
},
750750
"dfmt.alignSwitchStatements": {
751751
"type": "boolean",
@@ -859,31 +859,31 @@
859859
"type": "boolean",
860860
"scope": "resource",
861861
"default": false,
862-
"markdownDescription": "Add code lenses (gray text above source code) on import statements showing how long each import takes to compile on its own. Executes DMD, as set by `#d.dmdPath#`, to get the impact on compilation time by this import."
862+
"markdownDescription": "Add code lenses (gray text above source code) on import statements to show how long each import takes to compile on its own. Executes DMD, as set by `#d.dmdPath#`, to get the impact on compilation time by this import."
863863
},
864864
"d.enableCoverageDecoration": {
865865
"type": "boolean",
866866
"scope": "resource",
867867
"default": true,
868-
"markdownDescription": "Automatically highlights tested/untested coverage lines with light red/green backgrounds per line for `*.lst` files. You can for example run `dub test --config=unittest-cov` to run unittests and collect coverage information."
868+
"markdownDescription": "Automatically highlight tested/untested coverage inside source code with light red/green backgrounds from `*.lst` files. You can for example run `dub test --config=unittest-cov` to run unittests and collect coverage information."
869869
},
870870
"d.enableGCProfilerDecorations": {
871871
"type": "boolean",
872872
"scope": "resource",
873873
"default": true,
874-
"markdownDescription": "Automatically embed code lenses (gray text above source code) for all GC allocations based on `profilegc.log`. You can for example run `dub run --config=profile-gc` to run the project and see where the GC is actually used."
874+
"markdownDescription": "Automatically embed code lenses (gray text above source code) for GC allocations based on `profilegc.log`. You can for example run `dub run --config=profile-gc` to run the project and see where the GC is actually used."
875875
},
876876
"d.alwaysShowCoverageStatus": {
877877
"type": "boolean",
878878
"scope": "resource",
879879
"default": false,
880-
"markdownDescription": "Always shows D code coverage status when available through `.lst` files, and not just when a D file is open."
880+
"markdownDescription": "Always show D code coverage status in status bar when available through `.lst` files, and not just when a D file is open."
881881
},
882882
"d.generateModuleNames": {
883883
"type": "boolean",
884884
"scope": "resource",
885885
"default": true,
886-
"markdownDescription": "Automatically inserts or replaces the module name in the current file when creating or renaming a file."
886+
"markdownDescription": "Automatically insert or replace the `module name;` when creating or renaming a file."
887887
}
888888
}
889889
},
@@ -929,7 +929,7 @@
929929
"type": "boolean",
930930
"scope": "application",
931931
"default": true,
932-
"markdownDescription": "Randomly omits serve-d update checks to save bandwidth, lowers startup delay and minimizes breakage on new releases with quick fixes. Also avoids to update when working on fridays."
932+
"markdownDescription": "Randomly omit serve-d update checks to save bandwidth. Lowers startup delay and minimizes breakage on new releases with quick fixes. Also avoids to update when working on fridays."
933933
},
934934
"d.manyProjectsAction": {
935935
"type": "string",
@@ -958,7 +958,7 @@
958958
"type": "boolean",
959959
"scope": "window",
960960
"default": false,
961-
"markdownDescription": "No hints will be shown when a project may be wrongly configured when trying to start debugging."
961+
"markdownDescription": "Don't show alerts when a project may be wrongly configured when trying to start debugging."
962962
}
963963
}
964964
}

0 commit comments

Comments
 (0)