From 26c6e3ee4c9032c6aee0161afa46edb9079a7857 Mon Sep 17 00:00:00 2001 From: Mauricio Villegas <5780272+mauvilsa@users.noreply.github.com> Date: Thu, 20 Jul 2023 08:05:51 +0200 Subject: [PATCH] - Minor fix to readme. - Improve the writing of some messages. --- README.rst | 2 -- jsonargparse/_core.py | 8 ++++---- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index 7c20f7d8..ffa598f1 100644 --- a/README.rst +++ b/README.rst @@ -305,9 +305,7 @@ create a parser object and then add arguments to it. A simple example would be: from jsonargparse import ArgumentParser parser = ArgumentParser(prog="app", description="Description for my app.") - parser.add_argument("--opt1", type=int, default=0, help="Help for option 1.") - parser.add_argument("--opt2", type=float, default=1.0, help="Help for option 2.") diff --git a/jsonargparse/_core.py b/jsonargparse/_core.py index e77ea7fd..6a7bc92a 100644 --- a/jsonargparse/_core.py +++ b/jsonargparse/_core.py @@ -1330,7 +1330,7 @@ def default_config_files(self, default_config_files: Optional[List[Union[str, os ): self._default_config_files = [os.fspath(d) for d in default_config_files] else: - raise ValueError("default_config_files has to be None or List[str | os.PathLike].") + raise ValueError("default_config_files expects None or List[str | os.PathLike].") if len(self._default_config_files) > 0: if not hasattr(self, "_default_config_files_group"): @@ -1364,7 +1364,7 @@ def default_env(self, default_env: bool): elif isinstance(default_env, bool): self._default_env = default_env else: - raise ValueError("default_env has to be a boolean.") + raise ValueError("default_env expects a boolean.") if self._subcommands_action: for subparser in self._subcommands_action._name_parser_map.values(): subparser.default_env = self._default_env @@ -1386,7 +1386,7 @@ def default_meta(self, default_meta: bool): if isinstance(default_meta, bool): self._default_meta = default_meta else: - raise ValueError("default_meta has to be a boolean.") + raise ValueError("default_meta expects a boolean.") @property def env_prefix(self) -> Union[bool, str]: @@ -1413,7 +1413,7 @@ def env_prefix(self, env_prefix: Union[bool, str]): elif env_prefix is True: env_prefix = os.path.splitext(self.prog)[0] elif not isinstance(env_prefix, (bool, str)): - raise ValueError("env_prefix must be a string or a boolean.") + raise ValueError("env_prefix expects a string or a boolean.") self._env_prefix = env_prefix @property