From 6f99041ad949f260fb8f0a5a01514c3fcf97efd1 Mon Sep 17 00:00:00 2001 From: "L. Yeung" Date: Thu, 12 May 2022 18:40:17 +0800 Subject: [PATCH] docs(segments): revise descriptions for language segments --- .versionrc.json | 2 +- docs/docs/segments/angular.md | 5 ++--- docs/docs/segments/azfunc.md | 4 +--- docs/docs/segments/cds.md | 4 +--- docs/docs/segments/cf.md | 5 ++--- docs/docs/segments/crystal.md | 5 ++--- docs/docs/segments/dart.md | 5 ++--- docs/docs/segments/dotnet.md | 3 ++- docs/docs/segments/golang.md | 5 ++--- docs/docs/segments/haskell.md | 5 ++--- docs/docs/segments/java.md | 4 +--- docs/docs/segments/julia.md | 5 ++--- docs/docs/segments/kotlin.md | 5 ++--- docs/docs/segments/node.md | 5 ++--- docs/docs/segments/npm.md | 3 ++- docs/docs/segments/php.md | 5 ++--- docs/docs/segments/python.md | 5 ++--- docs/docs/segments/r.md | 5 ++--- docs/docs/segments/ruby.md | 4 +--- docs/docs/segments/rust.md | 4 +--- docs/docs/segments/swift.md | 5 ++--- docs/docs/segments/ui5tooling.md | 5 ++--- 22 files changed, 38 insertions(+), 60 deletions(-) diff --git a/.versionrc.json b/.versionrc.json index 5948bbe3..2acfe69f 100644 --- a/.versionrc.json +++ b/.versionrc.json @@ -14,7 +14,7 @@ }, { "type": "revert", - "section": "Refactor" + "section": "Reverts" }, { "type": "theme", diff --git a/docs/docs/segments/angular.md b/docs/docs/segments/angular.md index 0d32f5ca..e91aa92b 100644 --- a/docs/docs/segments/angular.md +++ b/docs/docs/segments/angular.md @@ -44,9 +44,8 @@ Display the currently active [Angular CLI][angular-cli-docs] version. - `.Major`: `string` - major number - `.Minor`: `string` - minor number - `.Patch`: `string` - patch number -- `.Prerelease`: `string` - prerelease info text -- `.BuildMetadata`: `string` - build metadata -- `.Error`: `string` - when fetching the version string errors +- `.URL`: `string` - URL of the version info / release notes +- `.Error`: `string` - error encountered when fetching the version string [templates]: /docs/configuration/templates [angular-cli-docs]: https://angular.io/cli diff --git a/docs/docs/segments/azfunc.md b/docs/docs/segments/azfunc.md index 1bcfb138..b37e8a1f 100644 --- a/docs/docs/segments/azfunc.md +++ b/docs/docs/segments/azfunc.md @@ -50,9 +50,7 @@ Display the currently active [Azure Functions CLI][az-func-core-tools] version. - `.Major`: `string` - major number - `.Minor`: `string` - minor number - `.Patch`: `string` - patch number -- `.Prerelease`: `string` - prerelease info text -- `.BuildMetadata`: `string` - build metadata -- `.Error`: `string` - when fetching the version string errors +- `.Error`: `string` - error encountered when fetching the version string [templates]: /docs/configuration/templates [az-func-core-tools]: https://github.com/Azure/azure-functions-core-tools diff --git a/docs/docs/segments/cds.md b/docs/docs/segments/cds.md index 24e9f4d4..d00a419b 100644 --- a/docs/docs/segments/cds.md +++ b/docs/docs/segments/cds.md @@ -48,9 +48,7 @@ Display the active [CDS CLI][sap-cap-cds] version. - `.Major`: `string` - major number - `.Minor`: `string` - minor number - `.Patch`: `string` - patch number -- `.Prerelease`: `string` - prerelease info text -- `.BuildMetadata`: `string` - build metadata -- `.Error`: `string` - when fetching the version string errors +- `.Error`: `string` - error encountered when fetching the version string - `.HasDependency`: `bool` - a flag if `@sap/cds` was found in `package.json` [templates]: /docs/configuration/templates diff --git a/docs/docs/segments/cf.md b/docs/docs/segments/cf.md index 2012efdb..f8375230 100644 --- a/docs/docs/segments/cf.md +++ b/docs/docs/segments/cf.md @@ -47,9 +47,8 @@ Display the active [Cloud Foundry CLI][cloud-foundry] version. - `.Major`: `string` - major number - `.Minor`: `string` - minor number - `.Patch`: `string` - patch number -- `.Prerelease`: `string` - prerelease info text -- `.BuildMetadata`: `string` - build metadata -- `.Error`: `string` - when fetching the version string errors +- `.URL`: `string` - URL of the version info / release notes +- `.Error`: `string` - error encountered when fetching the version string [templates]: /docs/configuration/templates [cloud-foundry]: https://github.com/cloudfoundry/cli diff --git a/docs/docs/segments/crystal.md b/docs/docs/segments/crystal.md index 344f4803..d41d1829 100644 --- a/docs/docs/segments/crystal.md +++ b/docs/docs/segments/crystal.md @@ -47,8 +47,7 @@ Display the currently active crystal version. - `.Major`: `string` - major number - `.Minor`: `string` - minor number - `.Patch`: `string` - patch number -- `.Prerelease`: `string` - prerelease info text -- `.BuildMetadata`: `string` - build metadata -- `.Error`: `string` - when fetching the version string errors +- `.URL`: `string` - URL of the version info / release notes +- `.Error`: `string` - error encountered when fetching the version string [templates]: /docs/configuration/templates diff --git a/docs/docs/segments/dart.md b/docs/docs/segments/dart.md index 6f132a6a..d4b900c0 100644 --- a/docs/docs/segments/dart.md +++ b/docs/docs/segments/dart.md @@ -48,8 +48,7 @@ folder are present (default) - `.Major`: `string` - major number - `.Minor`: `string` - minor number - `.Patch`: `string` - patch number -- `.Prerelease`: `string` - prerelease info text -- `.BuildMetadata`: `string` - build metadata -- `.Error`: `string` - when fetching the version string errors +- `.URL`: `string` - URL of the version info / release notes +- `.Error`: `string` - error encountered when fetching the version string [templates]: /docs/configuration/templates diff --git a/docs/docs/segments/dotnet.md b/docs/docs/segments/dotnet.md index 5c577b96..91642c28 100644 --- a/docs/docs/segments/dotnet.md +++ b/docs/docs/segments/dotnet.md @@ -52,7 +52,8 @@ Display the currently active [.NET SDK][net-sdk-docs] version. - `.Patch`: `string` - patch number - `.Prerelease`: `string` - prerelease info text - `.BuildMetadata`: `string` - build metadata -- `.Error`: `string` - when fetching the version string errors +- `.URL`: `string` - URL of the version info / release notes +- `.Error`: `string` - error encountered when fetching the version string [templates]: /docs/configuration/templates [net-sdk-docs]: https://docs.microsoft.com/en-us/dotnet/core/tools diff --git a/docs/docs/segments/golang.md b/docs/docs/segments/golang.md index 157bcf7c..511d2725 100644 --- a/docs/docs/segments/golang.md +++ b/docs/docs/segments/golang.md @@ -48,8 +48,7 @@ Display the currently active golang version. - `.Major`: `string` - major number - `.Minor`: `string` - minor number - `.Patch`: `string` - patch number -- `.Prerelease`: `string` - prerelease info text -- `.BuildMetadata`: `string` - build metadata -- `.Error`: `string` - when fetching the version string errors +- `.URL`: `string` - URL of the version info / release notes +- `.Error`: `string` - error encountered when fetching the version string [templates]: /docs/configuration/templates diff --git a/docs/docs/segments/haskell.md b/docs/docs/segments/haskell.md index dd930464..8b626ad6 100644 --- a/docs/docs/segments/haskell.md +++ b/docs/docs/segments/haskell.md @@ -53,9 +53,8 @@ Using stack ghc will decrease performance. - `.Major`: `string` - major number - `.Minor`: `string` - minor number - `.Patch`: `string` - patch number -- `.Prerelease`: `string` - prerelease info text -- `.BuildMetadata`: `string` - build metadata -- `.Error`: `string` - when fetching the version string errors +- `.URL`: `string` - URL of the version info / release notes +- `.Error`: `string` - error encountered when fetching the version string - `.StackGhc`: `boolean` - `true` if stack ghc was used, otherwise `false` [templates]: /docs/configuration/templates diff --git a/docs/docs/segments/java.md b/docs/docs/segments/java.md index d1700f29..d4f9fdbe 100644 --- a/docs/docs/segments/java.md +++ b/docs/docs/segments/java.md @@ -60,8 +60,6 @@ Display the currently active java version. - `.Major`: `string` - major number - `.Minor`: `string` - minor number - `.Patch`: `string` - patch number -- `.Prerelease`: `string` - prerelease info text -- `.BuildMetadata`: `string` - build metadata -- `.Error`: `string` - when fetching the version string errors +- `.Error`: `string` - error encountered when fetching the version string [templates]: /docs/configuration/templates diff --git a/docs/docs/segments/julia.md b/docs/docs/segments/julia.md index 623adeef..d1ae6941 100644 --- a/docs/docs/segments/julia.md +++ b/docs/docs/segments/julia.md @@ -47,8 +47,7 @@ Display the currently active julia version. - `.Major`: `string` - major number - `.Minor`: `string` - minor number - `.Patch`: `string` - patch number -- `.Prerelease`: `string` - prerelease info text -- `.BuildMetadata`: `string` - build metadata -- `.Error`: `string` - when fetching the version string errors +- `.URL`: `string` - URL of the version info / release notes +- `.Error`: `string` - error encountered when fetching the version string [templates]: /docs/configuration/templates diff --git a/docs/docs/segments/kotlin.md b/docs/docs/segments/kotlin.md index bf68d1e4..860db63c 100644 --- a/docs/docs/segments/kotlin.md +++ b/docs/docs/segments/kotlin.md @@ -47,9 +47,8 @@ Display the currently active [Kotlin][kotlin] version. - `.Major`: `string` - major number - `.Minor`: `string` - minor number - `.Patch`: `string` - patch number -- `.Prerelease`: `string` - prerelease info text -- `.BuildMetadata`: `string` - build metadata -- `.Error`: `string` - when fetching the version string errors +- `.URL`: `string` - URL of the version info / release notes +- `.Error`: `string` - error encountered when fetching the version string [templates]: /docs/configuration/templates [kotlin]: https://kotlinlang.org/ diff --git a/docs/docs/segments/node.md b/docs/docs/segments/node.md index e56a86a9..e232b031 100644 --- a/docs/docs/segments/node.md +++ b/docs/docs/segments/node.md @@ -49,9 +49,8 @@ Display the currently active [Node.js][node-js] version. - `.Major`: `string` - major number - `.Minor`: `string` - minor number - `.Patch`: `string` - patch number -- `.Prerelease`: `string` - prerelease info text -- `.BuildMetadata`: `string` - build metadata -- `.Error`: `string` - when fetching the version string errors +- `.URL`: `string` - URL of the version info / release notes +- `.Error`: `string` - error encountered when fetching the version string - `.PackageManagerIcon`: `string` - the Yarn on NPM icon when setting `fetch_package_manager` to `true` - `.Mismatch`: `boolean` - if the version in `.nvmrc` matches with `.Full` diff --git a/docs/docs/segments/npm.md b/docs/docs/segments/npm.md index c599203f..a4a1fa49 100644 --- a/docs/docs/segments/npm.md +++ b/docs/docs/segments/npm.md @@ -37,7 +37,8 @@ Display the currently active [npm][npm-docs] version. - `.Major`: `string` - major number - `.Minor`: `string` - minor number - `.Patch`: `string` - patch number -- `.Error`: `string` - when fetching the version string errors +- `.URL`: `string` - URL of the version info / release notes +- `.Error`: `string` - error encountered when fetching the version string [templates]: /docs/configuration/templates [npm-docs]: https://docs.npmjs.com/about-npm diff --git a/docs/docs/segments/php.md b/docs/docs/segments/php.md index 9feaca12..4b202e63 100644 --- a/docs/docs/segments/php.md +++ b/docs/docs/segments/php.md @@ -48,8 +48,7 @@ files are present (default) - `.Major`: `string` - major number - `.Minor`: `string` - minor number - `.Patch`: `string` - patch number -- `.Prerelease`: `string` - prerelease info text -- `.BuildMetadata`: `string` - build metadata -- `.Error`: `string` - when fetching the version string errors +- `.URL`: `string` - URL of the version info / release notes +- `.Error`: `string` - error encountered when fetching the version string [templates]: /docs/configuration/templates diff --git a/docs/docs/segments/python.md b/docs/docs/segments/python.md index 8331af12..6a3c8369 100644 --- a/docs/docs/segments/python.md +++ b/docs/docs/segments/python.md @@ -55,8 +55,7 @@ or not - defaults to `true` - `.Major`: `string` - major number - `.Minor`: `string` - minor number - `.Patch`: `string` - patch number -- `.Prerelease`: `string` - prerelease info text -- `.BuildMetadata`: `string` - build metadata -- `.Error`: `string` - when fetching the version string errors +- `.URL`: `string` - URL of the version info / release notes +- `.Error`: `string` - error encountered when fetching the version string [templates]: /docs/configuration/templates diff --git a/docs/docs/segments/r.md b/docs/docs/segments/r.md index 299db673..a736cfcb 100644 --- a/docs/docs/segments/r.md +++ b/docs/docs/segments/r.md @@ -48,9 +48,8 @@ Display the currently active [R][r-homepage] version. - `.Major`: `string` - major number - `.Minor`: `string` - minor number - `.Patch`: `string` - patch number -- `.Prerelease`: `string` - prerelease info text -- `.BuildMetadata`: `string` - build metadata -- `.Error`: `string` - when fetching the version string errors +- `.URL`: `string` - URL of the version info / release notes +- `.Error`: `string` - error encountered when fetching the version string [templates]: /docs/configuration/templates [r-homepage]: https://www.r-project.org/ diff --git a/docs/docs/segments/ruby.md b/docs/docs/segments/ruby.md index d5d19907..929240b9 100644 --- a/docs/docs/segments/ruby.md +++ b/docs/docs/segments/ruby.md @@ -47,8 +47,6 @@ Display the currently active ruby version. - `.Major`: `string` - major number - `.Minor`: `string` - minor number - `.Patch`: `string` - patch number -- `.Prerelease`: `string` - prerelease info text -- `.BuildMetadata`: `string` - build metadata -- `.Error`: `string` - when fetching the version string errors +- `.Error`: `string` - error encountered when fetching the version string [templates]: /docs/configuration/templates diff --git a/docs/docs/segments/rust.md b/docs/docs/segments/rust.md index 2eac7761..d1ad43b1 100644 --- a/docs/docs/segments/rust.md +++ b/docs/docs/segments/rust.md @@ -47,8 +47,6 @@ Display the currently active rust version. - `.Major`: `string` - major number - `.Minor`: `string` - minor number - `.Patch`: `string` - patch number -- `.Prerelease`: `string` - prerelease info text -- `.BuildMetadata`: `string` - build metadata -- `.Error`: `string` - when fetching the version string errors +- `.Error`: `string` - error encountered when fetching the version string [templates]: /docs/configuration/templates diff --git a/docs/docs/segments/swift.md b/docs/docs/segments/swift.md index 82d1c42d..2fcf1311 100644 --- a/docs/docs/segments/swift.md +++ b/docs/docs/segments/swift.md @@ -47,9 +47,8 @@ Display the currently active [Swift][swift] version. - `.Major`: `string` - major number - `.Minor`: `string` - minor number - `.Patch`: `string` - patch number -- `.Prerelease`: `string` - prerelease info text -- `.BuildMetadata`: `string` - build metadata -- `.Error`: `string` - when fetching the version string errors +- `.URL`: `string` - URL of the version info / release notes +- `.Error`: `string` - error encountered when fetching the version string [templates]: /docs/configuration/templates [swift]: https://www.swift.org/ diff --git a/docs/docs/segments/ui5tooling.md b/docs/docs/segments/ui5tooling.md index 65cf292a..baaa75c5 100644 --- a/docs/docs/segments/ui5tooling.md +++ b/docs/docs/segments/ui5tooling.md @@ -50,9 +50,8 @@ see [the documentation][ui5-version-help]). - `.Major`: `string` - major number - `.Minor`: `string` - minor number - `.Patch`: `string` - patch number -- `.Prerelease`: `string` - prerelease info text -- `.BuildMetadata`: `string` - build metadata -- `.Error`: `string` - when fetching the version string errors +- `.URL`: `string` - URL of the version info / release notes +- `.Error`: `string` - error encountered when fetching the version string [templates]: /docs/configuration/templates [ui5-homepage]: https://sap.github.io/ui5-tooling