Capitalize and punctuate one-line help texts properly (93a8790) - derivepassphrase.git

src/derivepassphrase/_internals/cli_messages.py

@@ -873,7 +873,7 @@ class Label(enum.Enum):
         '',
     )(
         'Label :: Help text :: One-line description',
-        'also emit debug information (implies --verbose)',
+        'Also emit debug information.  Implies --verbose.',
     )
     """"""
     EXPORT_VAULT_FORMAT_HELP_TEXT = commented(
@@ -881,9 +881,10 @@ class Label(enum.Enum):
         'the metavar is Label.EXPORT_VAULT_FORMAT_METAVAR_FMT.',
     )(
         'Label :: Help text :: One-line description',
-        'try the following storage format {metavar}; '
-        'may be specified multiple times, '
-        'formats will be tried in order {defaults_hint}',
+        'Try the following storage format {metavar}.  '
+        'If specified multiple times, the '
+        'formats will be tried in order.  '
+        '{defaults_hint}',
         flags='python-brace-format',
     )
     """"""
@@ -893,7 +894,7 @@ class Label(enum.Enum):
         'should not be translated.',
     )(
         'Label :: Help text :: One-line description',
-        '(default: v0.3, v0.2, storeroom)',
+        'Default: v0.3, v0.2, storeroom.',
     )
     """"""
     EXPORT_VAULT_KEY_HELP_TEXT = commented(
@@ -901,7 +902,7 @@ class Label(enum.Enum):
         'the metavar is Label.EXPORT_VAULT_KEY_METAVAR_K.',
     )(
         'Label :: Help text :: One-line description',
-        'use {metavar} as the storage master key {defaults_hint}',
+        'Use {metavar} as the storage master key.  {defaults_hint}',
         flags='python-brace-format',
     )
     """"""
@@ -909,36 +910,36 @@ class Label(enum.Enum):
         'See EXPORT_VAULT_KEY_HELP_TEXT.',
     )(
         'Label :: Help text :: One-line description',
-        '(default: check the `VAULT_KEY`, `LOGNAME`, `USER`, or '
-        '`USERNAME` environment variables)',
+        'Default: check the VAULT_KEY, LOGNAME, USER, or USERNAME '
+        'environment variables.',
     )
     """"""
     HELP_OPTION_HELP_TEXT = commented(
         '',
     )(
         'Label :: Help text :: One-line description',
-        'show this help text, then exit',
+        'Show this help text, then exit.',
     )
     """"""
     QUIET_OPTION_HELP_TEXT = commented(
         '',
     )(
         'Label :: Help text :: One-line description',
-        'suppress even warnings, emit only errors',
+        'Suppress even warnings; emit only errors.',
     )
     """"""
     VERBOSE_OPTION_HELP_TEXT = commented(
         '',
     )(
         'Label :: Help text :: One-line description',
-        'emit extra/progress information to standard error',
+        'Emit extra/progress information to standard error.',
     )
     """"""
     VERSION_OPTION_HELP_TEXT = commented(
         '',
     )(
         'Label :: Help text :: One-line description',
-        'show applicable version information, then exit',
+        'Show applicable version information, then exit.',
     )
     """"""
 
@@ -946,21 +947,21 @@ class Label(enum.Enum):
         '',
     )(
         'Label :: Help text :: One-line description',
-        'prompt for a master passphrase',
+        'Prompt for a master passphrase.',
     )
     """"""
     DERIVEPASSPHRASE_VAULT_KEY_HELP_TEXT = commented(
         '',
     )(
         'Label :: Help text :: One-line description',
-        'select a suitable SSH key from the SSH agent',
+        'Select a suitable SSH key from the SSH agent.',
     )
     """"""
     DERIVEPASSPHRASE_VAULT_LENGTH_HELP_TEXT = commented(
         'The metavar is Label.PASSPHRASE_GENERATION_METAVAR_NUMBER.',
     )(
         'Label :: Help text :: One-line description',
-        'ensure a passphrase length of {metavar} characters',
+        'Ensure a passphrase length of {metavar} characters.',
         flags='python-brace-format',
     )
     """"""
@@ -968,7 +969,7 @@ class Label(enum.Enum):
         'The metavar is Label.PASSPHRASE_GENERATION_METAVAR_NUMBER.',
     )(
         'Label :: Help text :: One-line description',
-        'forbid any run of {metavar} identical characters',
+        'Forbid any run of {metavar} identical characters.',
         flags='python-brace-format',
     )
     """"""
@@ -976,7 +977,7 @@ class Label(enum.Enum):
         'The metavar is Label.PASSPHRASE_GENERATION_METAVAR_NUMBER.',
     )(
         'Label :: Help text :: One-line description',
-        'ensure at least {metavar} lowercase characters',
+        'Ensure at least {metavar} lowercase characters.',
         flags='python-brace-format',
     )
     """"""
@@ -984,7 +985,7 @@ class Label(enum.Enum):
         'The metavar is Label.PASSPHRASE_GENERATION_METAVAR_NUMBER.',
     )(
         'Label :: Help text :: One-line description',
-        'ensure at least {metavar} uppercase characters',
+        'Ensure at least {metavar} uppercase characters.',
         flags='python-brace-format',
     )
     """"""
@@ -992,7 +993,7 @@ class Label(enum.Enum):
         'The metavar is Label.PASSPHRASE_GENERATION_METAVAR_NUMBER.',
     )(
         'Label :: Help text :: One-line description',
-        'ensure at least {metavar} digits',
+        'Ensure at least {metavar} digits.',
         flags='python-brace-format',
     )
     """"""
@@ -1000,7 +1001,7 @@ class Label(enum.Enum):
         'The metavar is Label.PASSPHRASE_GENERATION_METAVAR_NUMBER.',
     )(
         'Label :: Help text :: One-line description',
-        'ensure at least {metavar} spaces',
+        'Ensure at least {metavar} spaces.',
         flags='python-brace-format',
     )
     """"""
@@ -1008,7 +1009,7 @@ class Label(enum.Enum):
         'The metavar is Label.PASSPHRASE_GENERATION_METAVAR_NUMBER.',
     )(
         'Label :: Help text :: One-line description',
-        'ensure at least {metavar} "-" or "_" characters',
+        'Ensure at least {metavar} "-" or "_" characters.',
         flags='python-brace-format',
     )
     """"""
@@ -1016,7 +1017,7 @@ class Label(enum.Enum):
         'The metavar is Label.PASSPHRASE_GENERATION_METAVAR_NUMBER.',
     )(
         'Label :: Help text :: One-line description',
-        'ensure at least {metavar} symbol characters',
+        'Ensure at least {metavar} symbol characters.',
         flags='python-brace-format',
     )
     """"""
@@ -1025,7 +1026,7 @@ class Label(enum.Enum):
         'The metavar is Label.VAULT_METAVAR_SERVICE.',
     )(
         'Label :: Help text :: One-line description',
-        'spawn an editor to edit notes for {service_metavar}',
+        'Spawn an editor to edit notes for {service_metavar}.',
         flags='python-brace-format',
     )
     """"""
@@ -1033,7 +1034,7 @@ class Label(enum.Enum):
         'The metavar is Label.VAULT_METAVAR_SERVICE.',
     )(
         'Label :: Help text :: One-line description',
-        'save the given settings for {service_metavar}, or global',
+        'Save the given settings for {service_metavar}, or global.',
         flags='python-brace-format',
     )
     """"""
@@ -1041,7 +1042,7 @@ class Label(enum.Enum):
         'The metavar is Label.VAULT_METAVAR_SERVICE.',
     )(
         'Label :: Help text :: One-line description',
-        'delete the settings for {service_metavar}',
+        'Delete the settings for {service_metavar}.',
         flags='python-brace-format',
     )
     """"""
@@ -1049,21 +1050,21 @@ class Label(enum.Enum):
         '',
     )(
         'Label :: Help text :: One-line description',
-        'delete the global settings',
+        'Delete the global settings.',
     )
     """"""
     DERIVEPASSPHRASE_VAULT_DELETE_ALL_HELP_TEXT = commented(
         '',
     )(
         'Label :: Help text :: One-line description',
-        'delete all settings',
+        'Delete all settings.',
     )
     """"""
     DERIVEPASSPHRASE_VAULT_EXPORT_HELP_TEXT = commented(
         'The metavar is Label.STORAGE_MANAGEMENT_METAVAR_PATH.',
     )(
         'Label :: Help text :: One-line description',
-        'export all saved settings to {metavar}',
+        'Export all saved settings to {metavar}.',
         flags='python-brace-format',
     )
     """"""
@@ -1071,7 +1072,7 @@ class Label(enum.Enum):
         'The metavar is Label.STORAGE_MANAGEMENT_METAVAR_PATH.',
     )(
         'Label :: Help text :: One-line description',
-        'import saved settings from {metavar}',
+        'Import saved settings from {metavar}.',
         flags='python-brace-format',
     )
     """"""
@@ -1081,7 +1082,7 @@ class Label(enum.Enum):
         'hint that the default (merge) is the second of those options.',
     )(
         'Label :: Help text :: One-line description',
-        'overwrite or merge (default) the existing configuration',
+        'Overwrite or merge (default) the existing configuration.',
     )
     """"""
     DERIVEPASSPHRASE_VAULT_UNSET_HELP_TEXT = commented(
@@ -1093,8 +1094,8 @@ class Label(enum.Enum):
         '"--config" for this option to have any effect.',
     )(
         'Label :: Help text :: One-line description',
-        'with --config, also unsets the given setting; '
-        'may be specified multiple times',
+        'With --config, also unsets the given setting.  '
+        'May be specified multiple times.',
     )
     """"""
     DERIVEPASSPHRASE_VAULT_EXPORT_AS_HELP_TEXT = commented(
@@ -1103,7 +1104,7 @@ class Label(enum.Enum):
         'and sh refers to the POSIX sh format.',
     )(
         'Label :: Help text :: One-line description',
-        'when exporting, export as JSON (default) or POSIX sh',
+        'When exporting, export as JSON (default) or POSIX sh.',
     )
     """"""
     DERIVEPASSPHRASE_VAULT_EDITOR_INTERFACE_HELP_TEXT = commented(
@@ -1117,8 +1118,8 @@ class Label(enum.Enum):
         'if possible.',
     )(
         'Label :: Help text :: One-line description',
-        'edit notes using the modern editor interface '
-        'or the vault-like legacy one (default)',
+        'Edit notes using the modern editor interface '
+        'or the vault-like legacy one (default).',
     )
     """"""
     DERIVEPASSPHRASE_VAULT_PRINT_NOTES_BEFORE_HELP_TEXT = commented(
@@ -1127,8 +1128,8 @@ class Label(enum.Enum):
         'hint that the default (after) is the second of those options.',
     )(
         'Label :: Help text :: One-line description',
-        'print the service notes (if any) before or after (default) '
-        'the existing configuration',
+        'Print the service notes (if any) before or after (default) '
+        'the existing configuration.',
     )
     """"""
 


...	...	@@ -873,7 +873,7 @@ class Label(enum.Enum):
873	873	'',
874	874	)(
875	875	'Label :: Help text :: One-line description',
876		- 'also emit debug information (implies --verbose)',
	876	+ 'Also emit debug information. Implies --verbose.',
877	877	)
878	878	""""""
879	879	EXPORT_VAULT_FORMAT_HELP_TEXT = commented(
...	...	@@ -881,9 +881,10 @@ class Label(enum.Enum):
881	881	'the metavar is Label.EXPORT_VAULT_FORMAT_METAVAR_FMT.',
882	882	)(
883	883	'Label :: Help text :: One-line description',
884		- 'try the following storage format {metavar}; '
885		- 'may be specified multiple times, '
886		- 'formats will be tried in order {defaults_hint}',
	884	+ 'Try the following storage format {metavar}. '
	885	+ 'If specified multiple times, the '
	886	+ 'formats will be tried in order. '
	887	+ '{defaults_hint}',
887	888	flags='python-brace-format',
888	889	)
889	890	""""""
...	...	@@ -893,7 +894,7 @@ class Label(enum.Enum):
893	894	'should not be translated.',
894	895	)(
895	896	'Label :: Help text :: One-line description',
896		- '(default: v0.3, v0.2, storeroom)',
	897	+ 'Default: v0.3, v0.2, storeroom.',
897	898	)
898	899	""""""
899	900	EXPORT_VAULT_KEY_HELP_TEXT = commented(
...	...	@@ -901,7 +902,7 @@ class Label(enum.Enum):
901	902	'the metavar is Label.EXPORT_VAULT_KEY_METAVAR_K.',
902	903	)(
903	904	'Label :: Help text :: One-line description',
904		- 'use {metavar} as the storage master key {defaults_hint}',
	905	+ 'Use {metavar} as the storage master key. {defaults_hint}',
905	906	flags='python-brace-format',
906	907	)
907	908	""""""
...	...	@@ -909,36 +910,36 @@ class Label(enum.Enum):
909	910	'See EXPORT_VAULT_KEY_HELP_TEXT.',
910	911	)(
911	912	'Label :: Help text :: One-line description',
912		- '(default: check the `VAULT_KEY`, `LOGNAME`, `USER`, or '
913		- '`USERNAME` environment variables)',
	913	+ 'Default: check the VAULT_KEY, LOGNAME, USER, or USERNAME '
	914	+ 'environment variables.',
914	915	)
915	916	""""""
916	917	HELP_OPTION_HELP_TEXT = commented(
917	918	'',
918	919	)(
919	920	'Label :: Help text :: One-line description',
920		- 'show this help text, then exit',
	921	+ 'Show this help text, then exit.',
921	922	)
922	923	""""""
923	924	QUIET_OPTION_HELP_TEXT = commented(
924	925	'',
925	926	)(
926	927	'Label :: Help text :: One-line description',
927		- 'suppress even warnings, emit only errors',
	928	+ 'Suppress even warnings; emit only errors.',
928	929	)
929	930	""""""
930	931	VERBOSE_OPTION_HELP_TEXT = commented(
931	932	'',
932	933	)(
933	934	'Label :: Help text :: One-line description',
934		- 'emit extra/progress information to standard error',
	935	+ 'Emit extra/progress information to standard error.',
935	936	)
936	937	""""""
937	938	VERSION_OPTION_HELP_TEXT = commented(
938	939	'',
939	940	)(
940	941	'Label :: Help text :: One-line description',
941		- 'show applicable version information, then exit',
	942	+ 'Show applicable version information, then exit.',
942	943	)
943	944	""""""
944	945
...	...	@@ -946,21 +947,21 @@ class Label(enum.Enum):
946	947	'',
947	948	)(
948	949	'Label :: Help text :: One-line description',
949		- 'prompt for a master passphrase',
	950	+ 'Prompt for a master passphrase.',
950	951	)
951	952	""""""
952	953	DERIVEPASSPHRASE_VAULT_KEY_HELP_TEXT = commented(
953	954	'',
954	955	)(
955	956	'Label :: Help text :: One-line description',
956		- 'select a suitable SSH key from the SSH agent',
	957	+ 'Select a suitable SSH key from the SSH agent.',
957	958	)
958	959	""""""
959	960	DERIVEPASSPHRASE_VAULT_LENGTH_HELP_TEXT = commented(
960	961	'The metavar is Label.PASSPHRASE_GENERATION_METAVAR_NUMBER.',
961	962	)(
962	963	'Label :: Help text :: One-line description',
963		- 'ensure a passphrase length of {metavar} characters',
	964	+ 'Ensure a passphrase length of {metavar} characters.',
964	965	flags='python-brace-format',
965	966	)
966	967	""""""
...	...	@@ -968,7 +969,7 @@ class Label(enum.Enum):
968	969	'The metavar is Label.PASSPHRASE_GENERATION_METAVAR_NUMBER.',
969	970	)(
970	971	'Label :: Help text :: One-line description',
971		- 'forbid any run of {metavar} identical characters',
	972	+ 'Forbid any run of {metavar} identical characters.',
972	973	flags='python-brace-format',
973	974	)
974	975	""""""
...	...	@@ -976,7 +977,7 @@ class Label(enum.Enum):
976	977	'The metavar is Label.PASSPHRASE_GENERATION_METAVAR_NUMBER.',
977	978	)(
978	979	'Label :: Help text :: One-line description',
979		- 'ensure at least {metavar} lowercase characters',
	980	+ 'Ensure at least {metavar} lowercase characters.',
980	981	flags='python-brace-format',
981	982	)
982	983	""""""
...	...	@@ -984,7 +985,7 @@ class Label(enum.Enum):
984	985	'The metavar is Label.PASSPHRASE_GENERATION_METAVAR_NUMBER.',
985	986	)(
986	987	'Label :: Help text :: One-line description',
987		- 'ensure at least {metavar} uppercase characters',
	988	+ 'Ensure at least {metavar} uppercase characters.',
988	989	flags='python-brace-format',
989	990	)
990	991	""""""
...	...	@@ -992,7 +993,7 @@ class Label(enum.Enum):
992	993	'The metavar is Label.PASSPHRASE_GENERATION_METAVAR_NUMBER.',
993	994	)(
994	995	'Label :: Help text :: One-line description',
995		- 'ensure at least {metavar} digits',
	996	+ 'Ensure at least {metavar} digits.',
996	997	flags='python-brace-format',
997	998	)
998	999	""""""
...	...	@@ -1000,7 +1001,7 @@ class Label(enum.Enum):
1000	1001	'The metavar is Label.PASSPHRASE_GENERATION_METAVAR_NUMBER.',
1001	1002	)(
1002	1003	'Label :: Help text :: One-line description',
1003		- 'ensure at least {metavar} spaces',
	1004	+ 'Ensure at least {metavar} spaces.',
1004	1005	flags='python-brace-format',
1005	1006	)
1006	1007	""""""
...	...	@@ -1008,7 +1009,7 @@ class Label(enum.Enum):
1008	1009	'The metavar is Label.PASSPHRASE_GENERATION_METAVAR_NUMBER.',
1009	1010	)(
1010	1011	'Label :: Help text :: One-line description',
1011		- 'ensure at least {metavar} "-" or "_" characters',
	1012	+ 'Ensure at least {metavar} "-" or "_" characters.',
1012	1013	flags='python-brace-format',
1013	1014	)
1014	1015	""""""
...	...	@@ -1016,7 +1017,7 @@ class Label(enum.Enum):
1016	1017	'The metavar is Label.PASSPHRASE_GENERATION_METAVAR_NUMBER.',
1017	1018	)(
1018	1019	'Label :: Help text :: One-line description',
1019		- 'ensure at least {metavar} symbol characters',
	1020	+ 'Ensure at least {metavar} symbol characters.',
1020	1021	flags='python-brace-format',
1021	1022	)
1022	1023	""""""
...	...	@@ -1025,7 +1026,7 @@ class Label(enum.Enum):
1025	1026	'The metavar is Label.VAULT_METAVAR_SERVICE.',
1026	1027	)(
1027	1028	'Label :: Help text :: One-line description',
1028		- 'spawn an editor to edit notes for {service_metavar}',
	1029	+ 'Spawn an editor to edit notes for {service_metavar}.',
1029	1030	flags='python-brace-format',
1030	1031	)
1031	1032	""""""
...	...	@@ -1033,7 +1034,7 @@ class Label(enum.Enum):
1033	1034	'The metavar is Label.VAULT_METAVAR_SERVICE.',
1034	1035	)(
1035	1036	'Label :: Help text :: One-line description',
1036		- 'save the given settings for {service_metavar}, or global',
	1037	+ 'Save the given settings for {service_metavar}, or global.',
1037	1038	flags='python-brace-format',
1038	1039	)
1039	1040	""""""
...	...	@@ -1041,7 +1042,7 @@ class Label(enum.Enum):
1041	1042	'The metavar is Label.VAULT_METAVAR_SERVICE.',
1042	1043	)(
1043	1044	'Label :: Help text :: One-line description',
1044		- 'delete the settings for {service_metavar}',
	1045	+ 'Delete the settings for {service_metavar}.',
1045	1046	flags='python-brace-format',
1046	1047	)
1047	1048	""""""
...	...	@@ -1049,21 +1050,21 @@ class Label(enum.Enum):
1049	1050	'',
1050	1051	)(
1051	1052	'Label :: Help text :: One-line description',
1052		- 'delete the global settings',
	1053	+ 'Delete the global settings.',
1053	1054	)
1054	1055	""""""
1055	1056	DERIVEPASSPHRASE_VAULT_DELETE_ALL_HELP_TEXT = commented(
1056	1057	'',
1057	1058	)(
1058	1059	'Label :: Help text :: One-line description',
1059		- 'delete all settings',
	1060	+ 'Delete all settings.',
1060	1061	)
1061	1062	""""""
1062	1063	DERIVEPASSPHRASE_VAULT_EXPORT_HELP_TEXT = commented(
1063	1064	'The metavar is Label.STORAGE_MANAGEMENT_METAVAR_PATH.',
1064	1065	)(
1065	1066	'Label :: Help text :: One-line description',
1066		- 'export all saved settings to {metavar}',
	1067	+ 'Export all saved settings to {metavar}.',
1067	1068	flags='python-brace-format',
1068	1069	)
1069	1070	""""""
...	...	@@ -1071,7 +1072,7 @@ class Label(enum.Enum):
1071	1072	'The metavar is Label.STORAGE_MANAGEMENT_METAVAR_PATH.',
1072	1073	)(
1073	1074	'Label :: Help text :: One-line description',
1074		- 'import saved settings from {metavar}',
	1075	+ 'Import saved settings from {metavar}.',
1075	1076	flags='python-brace-format',
1076	1077	)
1077	1078	""""""
...	...	@@ -1081,7 +1082,7 @@ class Label(enum.Enum):
1081	1082	'hint that the default (merge) is the second of those options.',
1082	1083	)(
1083	1084	'Label :: Help text :: One-line description',
1084		- 'overwrite or merge (default) the existing configuration',
	1085	+ 'Overwrite or merge (default) the existing configuration.',
1085	1086	)
1086	1087	""""""
1087	1088	DERIVEPASSPHRASE_VAULT_UNSET_HELP_TEXT = commented(
...	...	@@ -1093,8 +1094,8 @@ class Label(enum.Enum):
1093	1094	'"--config" for this option to have any effect.',
1094	1095	)(
1095	1096	'Label :: Help text :: One-line description',
1096		- 'with --config, also unsets the given setting; '
1097		- 'may be specified multiple times',
	1097	+ 'With --config, also unsets the given setting. '
	1098	+ 'May be specified multiple times.',
1098	1099	)
1099	1100	""""""
1100	1101	DERIVEPASSPHRASE_VAULT_EXPORT_AS_HELP_TEXT = commented(
...	...	@@ -1103,7 +1104,7 @@ class Label(enum.Enum):
1103	1104	'and sh refers to the POSIX sh format.',
1104	1105	)(
1105	1106	'Label :: Help text :: One-line description',
1106		- 'when exporting, export as JSON (default) or POSIX sh',
	1107	+ 'When exporting, export as JSON (default) or POSIX sh.',
1107	1108	)
1108	1109	""""""
1109	1110	DERIVEPASSPHRASE_VAULT_EDITOR_INTERFACE_HELP_TEXT = commented(
...	...	@@ -1117,8 +1118,8 @@ class Label(enum.Enum):
1117	1118	'if possible.',
1118	1119	)(
1119	1120	'Label :: Help text :: One-line description',
1120		- 'edit notes using the modern editor interface '
1121		- 'or the vault-like legacy one (default)',
	1121	+ 'Edit notes using the modern editor interface '
	1122	+ 'or the vault-like legacy one (default).',
1122	1123	)
1123	1124	""""""
1124	1125	DERIVEPASSPHRASE_VAULT_PRINT_NOTES_BEFORE_HELP_TEXT = commented(
...	...	@@ -1127,8 +1128,8 @@ class Label(enum.Enum):
1127	1128	'hint that the default (after) is the second of those options.',
1128	1129	)(
1129	1130	'Label :: Help text :: One-line description',
1130		- 'print the service notes (if any) before or after (default) '
1131		- 'the existing configuration',
	1131	+ 'Print the service notes (if any) before or after (default) '
	1132	+ 'the existing configuration.',
1132	1133	)
1133	1134	""""""
1134	1135
1135	1136