Skip to content

Commit 6f99041

Browse files
L. YeungJanDeDobbeleer
L. Yeung
authored and
JanDeDobbeleer
committed
docs(segments): revise descriptions for language segments
1 parent 8c9b635 commit 6f99041

22 files changed

+38
-60
lines changed

‎.versionrc.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
},
1515
{
1616
"type": "revert",
17-
"section": "Refactor"
17+
"section": "Reverts"
1818
},
1919
{
2020
"type": "theme",

‎docs/docs/segments/angular.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,8 @@ Display the currently active [Angular CLI][angular-cli-docs] version.
4444
- `.Major`: `string` - major number
4545
- `.Minor`: `string` - minor number
4646
- `.Patch`: `string` - patch number
47-
- `.Prerelease`: `string` - prerelease info text
48-
- `.BuildMetadata`: `string` - build metadata
49-
- `.Error`: `string` - when fetching the version string errors
47+
- `.URL`: `string` - URL of the version info / release notes
48+
- `.Error`: `string` - error encountered when fetching the version string
5049

5150
[templates]: /docs/configuration/templates
5251
[angular-cli-docs]: https://angular.io/cli

‎docs/docs/segments/azfunc.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,7 @@ Display the currently active [Azure Functions CLI][az-func-core-tools] version.
5050
- `.Major`: `string` - major number
5151
- `.Minor`: `string` - minor number
5252
- `.Patch`: `string` - patch number
53-
- `.Prerelease`: `string` - prerelease info text
54-
- `.BuildMetadata`: `string` - build metadata
55-
- `.Error`: `string` - when fetching the version string errors
53+
- `.Error`: `string` - error encountered when fetching the version string
5654

5755
[templates]: /docs/configuration/templates
5856
[az-func-core-tools]: https://github.com/Azure/azure-functions-core-tools

‎docs/docs/segments/cds.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,7 @@ Display the active [CDS CLI][sap-cap-cds] version.
4848
- `.Major`: `string` - major number
4949
- `.Minor`: `string` - minor number
5050
- `.Patch`: `string` - patch number
51-
- `.Prerelease`: `string` - prerelease info text
52-
- `.BuildMetadata`: `string` - build metadata
53-
- `.Error`: `string` - when fetching the version string errors
51+
- `.Error`: `string` - error encountered when fetching the version string
5452
- `.HasDependency`: `bool` - a flag if `@sap/cds` was found in `package.json`
5553

5654
[templates]: /docs/configuration/templates

‎docs/docs/segments/cf.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,8 @@ Display the active [Cloud Foundry CLI][cloud-foundry] version.
4747
- `.Major`: `string` - major number
4848
- `.Minor`: `string` - minor number
4949
- `.Patch`: `string` - patch number
50-
- `.Prerelease`: `string` - prerelease info text
51-
- `.BuildMetadata`: `string` - build metadata
52-
- `.Error`: `string` - when fetching the version string errors
50+
- `.URL`: `string` - URL of the version info / release notes
51+
- `.Error`: `string` - error encountered when fetching the version string
5352

5453
[templates]: /docs/configuration/templates
5554
[cloud-foundry]: https://github.com/cloudfoundry/cli

‎docs/docs/segments/crystal.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,7 @@ Display the currently active crystal version.
4747
- `.Major`: `string` - major number
4848
- `.Minor`: `string` - minor number
4949
- `.Patch`: `string` - patch number
50-
- `.Prerelease`: `string` - prerelease info text
51-
- `.BuildMetadata`: `string` - build metadata
52-
- `.Error`: `string` - when fetching the version string errors
50+
- `.URL`: `string` - URL of the version info / release notes
51+
- `.Error`: `string` - error encountered when fetching the version string
5352

5453
[templates]: /docs/configuration/templates

‎docs/docs/segments/dart.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,7 @@ folder are present (default)
4848
- `.Major`: `string` - major number
4949
- `.Minor`: `string` - minor number
5050
- `.Patch`: `string` - patch number
51-
- `.Prerelease`: `string` - prerelease info text
52-
- `.BuildMetadata`: `string` - build metadata
53-
- `.Error`: `string` - when fetching the version string errors
51+
- `.URL`: `string` - URL of the version info / release notes
52+
- `.Error`: `string` - error encountered when fetching the version string
5453

5554
[templates]: /docs/configuration/templates

‎docs/docs/segments/dotnet.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,8 @@ Display the currently active [.NET SDK][net-sdk-docs] version.
5252
- `.Patch`: `string` - patch number
5353
- `.Prerelease`: `string` - prerelease info text
5454
- `.BuildMetadata`: `string` - build metadata
55-
- `.Error`: `string` - when fetching the version string errors
55+
- `.URL`: `string` - URL of the version info / release notes
56+
- `.Error`: `string` - error encountered when fetching the version string
5657

5758
[templates]: /docs/configuration/templates
5859
[net-sdk-docs]: https://docs.microsoft.com/en-us/dotnet/core/tools

‎docs/docs/segments/golang.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,7 @@ Display the currently active golang version.
4848
- `.Major`: `string` - major number
4949
- `.Minor`: `string` - minor number
5050
- `.Patch`: `string` - patch number
51-
- `.Prerelease`: `string` - prerelease info text
52-
- `.BuildMetadata`: `string` - build metadata
53-
- `.Error`: `string` - when fetching the version string errors
51+
- `.URL`: `string` - URL of the version info / release notes
52+
- `.Error`: `string` - error encountered when fetching the version string
5453

5554
[templates]: /docs/configuration/templates

‎docs/docs/segments/haskell.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,8 @@ Using stack ghc will decrease performance.
5353
- `.Major`: `string` - major number
5454
- `.Minor`: `string` - minor number
5555
- `.Patch`: `string` - patch number
56-
- `.Prerelease`: `string` - prerelease info text
57-
- `.BuildMetadata`: `string` - build metadata
58-
- `.Error`: `string` - when fetching the version string errors
56+
- `.URL`: `string` - URL of the version info / release notes
57+
- `.Error`: `string` - error encountered when fetching the version string
5958
- `.StackGhc`: `boolean` - `true` if stack ghc was used, otherwise `false`
6059

6160
[templates]: /docs/configuration/templates

‎docs/docs/segments/java.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,6 @@ Display the currently active java version.
6060
- `.Major`: `string` - major number
6161
- `.Minor`: `string` - minor number
6262
- `.Patch`: `string` - patch number
63-
- `.Prerelease`: `string` - prerelease info text
64-
- `.BuildMetadata`: `string` - build metadata
65-
- `.Error`: `string` - when fetching the version string errors
63+
- `.Error`: `string` - error encountered when fetching the version string
6664

6765
[templates]: /docs/configuration/templates

‎docs/docs/segments/julia.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,7 @@ Display the currently active julia version.
4747
- `.Major`: `string` - major number
4848
- `.Minor`: `string` - minor number
4949
- `.Patch`: `string` - patch number
50-
- `.Prerelease`: `string` - prerelease info text
51-
- `.BuildMetadata`: `string` - build metadata
52-
- `.Error`: `string` - when fetching the version string errors
50+
- `.URL`: `string` - URL of the version info / release notes
51+
- `.Error`: `string` - error encountered when fetching the version string
5352

5453
[templates]: /docs/configuration/templates

‎docs/docs/segments/kotlin.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,8 @@ Display the currently active [Kotlin][kotlin] version.
4747
- `.Major`: `string` - major number
4848
- `.Minor`: `string` - minor number
4949
- `.Patch`: `string` - patch number
50-
- `.Prerelease`: `string` - prerelease info text
51-
- `.BuildMetadata`: `string` - build metadata
52-
- `.Error`: `string` - when fetching the version string errors
50+
- `.URL`: `string` - URL of the version info / release notes
51+
- `.Error`: `string` - error encountered when fetching the version string
5352

5453
[templates]: /docs/configuration/templates
5554
[kotlin]: https://kotlinlang.org/

‎docs/docs/segments/node.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,8 @@ Display the currently active [Node.js][node-js] version.
4949
- `.Major`: `string` - major number
5050
- `.Minor`: `string` - minor number
5151
- `.Patch`: `string` - patch number
52-
- `.Prerelease`: `string` - prerelease info text
53-
- `.BuildMetadata`: `string` - build metadata
54-
- `.Error`: `string` - when fetching the version string errors
52+
- `.URL`: `string` - URL of the version info / release notes
53+
- `.Error`: `string` - error encountered when fetching the version string
5554
- `.PackageManagerIcon`: `string` - the Yarn on NPM icon when setting `fetch_package_manager` to `true`
5655
- `.Mismatch`: `boolean` - if the version in `.nvmrc` matches with `.Full`
5756

‎docs/docs/segments/npm.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,8 @@ Display the currently active [npm][npm-docs] version.
3737
- `.Major`: `string` - major number
3838
- `.Minor`: `string` - minor number
3939
- `.Patch`: `string` - patch number
40-
- `.Error`: `string` - when fetching the version string errors
40+
- `.URL`: `string` - URL of the version info / release notes
41+
- `.Error`: `string` - error encountered when fetching the version string
4142

4243
[templates]: /docs/configuration/templates
4344
[npm-docs]: https://docs.npmjs.com/about-npm

‎docs/docs/segments/php.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,7 @@ files are present (default)
4848
- `.Major`: `string` - major number
4949
- `.Minor`: `string` - minor number
5050
- `.Patch`: `string` - patch number
51-
- `.Prerelease`: `string` - prerelease info text
52-
- `.BuildMetadata`: `string` - build metadata
53-
- `.Error`: `string` - when fetching the version string errors
51+
- `.URL`: `string` - URL of the version info / release notes
52+
- `.Error`: `string` - error encountered when fetching the version string
5453

5554
[templates]: /docs/configuration/templates

‎docs/docs/segments/python.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,7 @@ or not - defaults to `true`
5555
- `.Major`: `string` - major number
5656
- `.Minor`: `string` - minor number
5757
- `.Patch`: `string` - patch number
58-
- `.Prerelease`: `string` - prerelease info text
59-
- `.BuildMetadata`: `string` - build metadata
60-
- `.Error`: `string` - when fetching the version string errors
58+
- `.URL`: `string` - URL of the version info / release notes
59+
- `.Error`: `string` - error encountered when fetching the version string
6160

6261
[templates]: /docs/configuration/templates

‎docs/docs/segments/r.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,8 @@ Display the currently active [R][r-homepage] version.
4848
- `.Major`: `string` - major number
4949
- `.Minor`: `string` - minor number
5050
- `.Patch`: `string` - patch number
51-
- `.Prerelease`: `string` - prerelease info text
52-
- `.BuildMetadata`: `string` - build metadata
53-
- `.Error`: `string` - when fetching the version string errors
51+
- `.URL`: `string` - URL of the version info / release notes
52+
- `.Error`: `string` - error encountered when fetching the version string
5453

5554
[templates]: /docs/configuration/templates
5655
[r-homepage]: https://www.r-project.org/

‎docs/docs/segments/ruby.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,6 @@ Display the currently active ruby version.
4747
- `.Major`: `string` - major number
4848
- `.Minor`: `string` - minor number
4949
- `.Patch`: `string` - patch number
50-
- `.Prerelease`: `string` - prerelease info text
51-
- `.BuildMetadata`: `string` - build metadata
52-
- `.Error`: `string` - when fetching the version string errors
50+
- `.Error`: `string` - error encountered when fetching the version string
5351

5452
[templates]: /docs/configuration/templates

‎docs/docs/segments/rust.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,6 @@ Display the currently active rust version.
4747
- `.Major`: `string` - major number
4848
- `.Minor`: `string` - minor number
4949
- `.Patch`: `string` - patch number
50-
- `.Prerelease`: `string` - prerelease info text
51-
- `.BuildMetadata`: `string` - build metadata
52-
- `.Error`: `string` - when fetching the version string errors
50+
- `.Error`: `string` - error encountered when fetching the version string
5351

5452
[templates]: /docs/configuration/templates

‎docs/docs/segments/swift.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,8 @@ Display the currently active [Swift][swift] version.
4747
- `.Major`: `string` - major number
4848
- `.Minor`: `string` - minor number
4949
- `.Patch`: `string` - patch number
50-
- `.Prerelease`: `string` - prerelease info text
51-
- `.BuildMetadata`: `string` - build metadata
52-
- `.Error`: `string` - when fetching the version string errors
50+
- `.URL`: `string` - URL of the version info / release notes
51+
- `.Error`: `string` - error encountered when fetching the version string
5352

5453
[templates]: /docs/configuration/templates
5554
[swift]: https://www.swift.org/

‎docs/docs/segments/ui5tooling.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,8 @@ see [the documentation][ui5-version-help]).
5050
- `.Major`: `string` - major number
5151
- `.Minor`: `string` - minor number
5252
- `.Patch`: `string` - patch number
53-
- `.Prerelease`: `string` - prerelease info text
54-
- `.BuildMetadata`: `string` - build metadata
55-
- `.Error`: `string` - when fetching the version string errors
53+
- `.URL`: `string` - URL of the version info / release notes
54+
- `.Error`: `string` - error encountered when fetching the version string
5655

5756
[templates]: /docs/configuration/templates
5857
[ui5-homepage]: https://sap.github.io/ui5-tooling

0 commit comments

Comments
 (0)