Further explain kwargs for Python stack funcs #9794
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The *_stack functions in the pulumi.automation package take keyword arguments that control where the program used in the stack comes from. In particular, the keyword argument work_dir (and absence of program and project_name) indicates that the program should be constructed using the given directory. There's _also_ a field with the same name accepted in the opts argument, leading to confusion in at least one case (see #8436). This commit tries to mitigate the confusion by making the docstrings for those functions more explicit about which arguments are required and ignored in each case. Signed-off-by: Michael Bridgen <mbridgen@pulumi.com>
Signed-off-by: Michael Bridgen <mbridgen@pulumi.com>
squaremo
force-pushed
the
work_dir_arg_issue8436
branch
from
5be27db
to
2e3b24e
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The *_stack functions in the pulumi.automation package take keyword arguments that control where the program used in the stack comes from. In particular, the keyword argument work_dir (and absence of program and project_name) indicates that the program should be constructed using the given directory. There's also a field with the same name accepted in the opts argument, leading to confusion in at least one case (see #8436).
This commit tries to mitigate the confusion by making the docstrings for those functions more explicit about which arguments are required and ignored in each case.
Addresses #8436.
Checklist
No additional or adapted tests -- Python docstring changes only.
I have updated the CHANGELOG-PENDING file with my change
Yes, there are changes in this PR that warrants bumping the Pulumi Service API version