Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing documentation: linked_targets in add_class_arguments() #317

Closed
noamsgl opened this issue Jul 5, 2023 · 1 comment · Fixed by #365
Closed

Missing documentation: linked_targets in add_class_arguments() #317

noamsgl opened this issue Jul 5, 2023 · 1 comment · Fixed by #365
Labels
documentation Improvements to the documentation

Comments

@noamsgl
Copy link

noamsgl commented Jul 5, 2023

What is the meaning of this argument? How and when would you use, for example? Thanks!
https://github.com/omni-us/jsonargparse/blob/c4514d49e31b0a5a494273cc647e48f848fe15b4/jsonargparse/_signatures.py#L51C13-
L51C13

@mauvilsa
Copy link
Member

mauvilsa commented Jul 6, 2023

@noamsgl thank you for pointing this out. From what I see that parameter was added in commit 30a8235. The linked_targets parameter is only necessary for the internal logic of linked arguments. What it does is that when a parameter is required (no default), but it is the target of a link, then that parameter is added as not required and without a default.

I don't see this parameter being useful for anything else apart from this internal usage. I will hide it from the public API.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements to the documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants