Skip to content

Commit

Permalink
Remove private linked_targets parameter from API Reference (#317).
Browse files Browse the repository at this point in the history
  • Loading branch information
mauvilsa committed Aug 30, 2023
1 parent 8356fdf commit 323b4a5
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 2 deletions.
9 changes: 9 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,15 @@ The semantic versioning only considers the public API as described in
paths are considered internals and can change in minor and patch releases.


v4.24.1 (2023-09-??)
--------------------

Fixed
^^^^^
- Remove private ``linked_targets`` parameter from API Reference (`#317
<https://github.com/omni-us/jsonargparse/issues/317>`__).


v4.24.0 (2023-08-23)
--------------------

Expand Down
5 changes: 3 additions & 2 deletions jsonargparse/_signatures.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
callable_instances,
is_optional,
)
from ._util import LoggerProperty, get_import_path, iter_to_set_str
from ._util import LoggerProperty, get_import_path, get_private_kwargs, iter_to_set_str
from .typing import register_pydantic_type

__all__ = [
Expand All @@ -48,7 +48,7 @@ def add_class_arguments(
instantiate: bool = True,
fail_untyped: bool = True,
sub_configs: bool = False,
linked_targets: Optional[Set[str]] = None,
**kwargs,
) -> List[str]:
"""Adds arguments from a class based on its type hints and docstrings.
Expand Down Expand Up @@ -76,6 +76,7 @@ def add_class_arguments(
raise ValueError(f'Expected "theclass" parameter to be a class type, got: {theclass}.')
if default and not (isinstance(default, LazyInitBaseClass) and isinstance(default, theclass)):
raise ValueError(f'Expected "default" parameter to be a lazy instance of the class, got: {default}.')
linked_targets = get_private_kwargs(kwargs, linked_targets=None)

added_args = self._add_signature_arguments(
theclass,
Expand Down

0 comments on commit 323b4a5

Please sign in to comment.