sevenhill/QSfera
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix minor typo

Browse Source 
In the deprecation document there is a typo `on` --> `one`
Missed that one while reviewing.
This commit is contained in:
Martin
2022-11-29 16:34:45 +01:00
committed by GitHub
parent c527dae616
commit f0ed26ae2a
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/ocis/development/deprecating-variables.md
+2 -2
View File
@@ -32,8 +32,8 @@ There are four different annotation variables that need to be filled:
| depreactionVersion| The version the variable will be deprecated| semver (e.g. 1.6.2)| | depreactionVersion| The version the variable will be deprecated| semver (e.g. 1.6.2)|
| removalVersion| The version the variable will be removed from the codebase| semver (e.g. 1.7.3)| | removalVersion| The version the variable will be removed from the codebase| semver (e.g. 1.7.3)|
| deprecationInfo| Information why the variable is deprecated, must start with the name of the variable in order to avoid confusion, when there are multiple options in the `env:`-field | string (e.g. NATS_NATS_HOST is confusing) | | deprecationInfo| Information why the variable is deprecated, must start with the name of the variable in order to avoid confusion, when there are multiple options in the `env:`-field | string (e.g. NATS_NATS_HOST is confusing) |
| depreactionReplacement | The name of the variable that is going to replace the deprecated on.| string (e.g. NATS_HOST_ADDRESS)| | depreactionReplacement | The name of the variable that is going to replace the deprecated one.| string (e.g. NATS_HOST_ADDRESS)|
### What happens next? ### What happens next?
Once a variable has been finally removed, the annotations must be removed again from the code, since they do not serve any purpose from this point. Once a variable has been finally removed, the annotations must be removed again from the code, since they do not serve any purpose from this point.