From 3ce870fdf061428fa302e8ed8f4dddfec1544f1c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Sta=C5=9Bczak?= Date: Thu, 28 Dec 2023 23:10:24 +0100 Subject: [PATCH] Improve phrasing --- CHANGELOG.md | 32 +++++++++++++++++--------------- 1 file changed, 17 insertions(+), 15 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 752d860..4b9eb5a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -24,8 +24,8 @@ Types of changes: - Documentation of the project's roadmap (PR [#50], [#70]). - Command to echo database version and file path (issue [#32], PR [#67]). - Command to echo the application's version (issue [#71], PR [#72]). -- `--debug/--no-debug` option, which allows to enable or disable debug info (PR [#82]). -- Documentation of the project's version history AKA changelog (PR [#83]). +- Option `--debug/--no-debug`, which allows to enable or disable debug info (PR [#82]). +- Documentation of the project's version history AKA this changelog (PR [#83]). [#32]: https://github.com/apptension/onetimepass/issues/32 [#50]: https://github.com/apptension/onetimepass/pull/50 @@ -44,7 +44,7 @@ Types of changes: ### Removed -- The `show-all` command (issue [#27], PR [#40]). +- Command `show-all` (issue [#27], PR [#40]). [#27]: https://github.com/apptension/onetimepass/issues/27 [#40]: https://github.com/apptension/onetimepass/pull/40 @@ -56,28 +56,30 @@ Types of changes: [#31]). - The counter in HOTP is incremented _after_ the OTP is shown. Now, it is correctly incremented _before_ the OTP is shown (issue [#39], PR [#41]). -- `add hotp` raises unhandled exception on missing `-c, --counter` option. Now, - it defaults to `0` (issue [#33], PR [#42]). -- The app does not store `label` and `issuer` parameters. Now, it stores them +- Command `add hotp` raises unhandled exception on missing option `-c, + --counter`. Now, the option defaults to value `0` (issue [#33], PR [#42]). +- The app does not store parameters `label` and `issuer`. Now, it stores them (issue [#34], PR [#44]). -- Invalid type annotation of `wait` option (PR [#45]). +- Invalid type annotation of option `wait` (PR [#45]). - Error message for invalid hash algorithm shows the implementation details. Now, it shows the possible values expected from the user (issue [#46], PR [#48]). -- `otp -k key` raises unhandled exception if the keyring is not installed. Now, - it shows an appropriate error message (issue [#56], PR [#57]). -- `add uri` command does not conform in 100% to the Key Uri Format - specification: `secret` parameter is handled as plain text, not Base32; some +- Command `otp -k key` raises unhandled exception if the keyring is not + installed. Now, it shows an appropriate error message (issue [#56], PR [#57]). +- Command `add uri` does not conform in 100% to the Key Uri Format + specification: parameter `secret` is handled as plain text, not Base32; some parameters that are supposed to be optional according to the spec, are required by the application. Now, it conforms (issue [#37], PR [#58]). - Redundant re-input of database password. Now, it is removed (PR [#58]). -- `secret` string is handled as-is, not interpreted as the Base32. Now, it is - interpreted as the Base32 (issue [#38], PR [#65]). +- When entered manually (not as a part of the Key URI), parameter `secret` is + handled as-is, not interpreted as the Base32. Now, it is interpreted as the + Base32 (issue [#38], PR [#65]). - Shadowed variable `algorithm`. Now, it is renamed, along with several other variables named `*algorithm` (issue [#47], PR [#68]). - Regression after renaming `*algorithm` variables (issue [#75], PR [#76]). -- `digits` parameter in URI not being optional. Now, it is optional (issue +- Parameter `digits` in Key URI not being optional. Now, it is optional (issue [#77], PR [#78]). -- `secret` not being case-insensitive (issue [#80], PR [#81]). +- Parameter `secret` not being case-insensitive. Now, it is case-insensitive + (issue [#80], PR [#81]). - CI/CD after periodic breakdowns (issue [#51], [#61]; PR [#52], [#62], [#66]). [#26]: https://github.com/apptension/onetimepass/issues/26