Skip to content

Commit 02b94f7

Browse files
docs: remove . from command snippet (#2998)
The impression of `by running:\n\t${SOME COMMAND}` is that you're displaying a console command with the expectation that users may copy paste that line. But this includes a period at the end of the command, weirdly mixing plain english docs punctuation with where a literal command should be. Users who copy paste the line will get the error ``` $ scala-cli config power true. [error] Config DB error: Malformed value 'true.' for the 'power' entry, expected a single boolean value ('true' or 'false'). ``` until they realize they need to omit the `.`
1 parent 5c55c0d commit 02b94f7

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

modules/build/src/main/scala/scala/build/internal/util/WarningMessages.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ object WarningMessages {
7171
if specificationLevel == SpecificationLevel.EXPERIMENTAL then "experimental" else "restricted"
7272
s"""The `$featureName` $featureType is $powerType.
7373
|You can run it with the `--power` flag or turn power mode on globally by running:
74-
| ${Console.BOLD}${invokeData.progName} config power true${Console.RESET}.""".stripMargin
74+
| ${Console.BOLD}${invokeData.progName} config power true${Console.RESET}""".stripMargin
7575
}
7676

7777
def powerCommandUsedInSip(commandName: String, specificationLevel: SpecificationLevel)(using

website/docs/release_notes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1782,7 +1782,7 @@ only be available in `--power` mode.
17821782
scala-cli config httpProxy.address
17831783
# The 'httpProxy.address' configuration key is restricted.
17841784
# You can run it with the '--power' flag or turn power mode on globally by running:
1785-
# scala-cli config power true.
1785+
# scala-cli config power true
17861786
```
17871787

17881788
Added by [@Gedochao](https://github.com/Gedochao) in [#1953](https://github.com/VirtusLab/scala-cli/pull/1953)

0 commit comments

Comments
 (0)