pulumi/sdk/python/lib
Michael Bridgen e32aa26e79
Further explain kwargs for Python stack funcs (#9794)
* Further explain kwargs for Python stack funcs

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 https://github.com/pulumi/pulumi/issues/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>

* Add pending changelog entry for PR9794

Signed-off-by: Michael Bridgen <mbridgen@pulumi.com>

Co-authored-by: Fraser Waters <fraser@pulumi.com>
2022-06-09 09:02:17 +01:00
..
pulumi Further explain kwargs for Python stack funcs (#9794) 2022-06-09 09:02:17 +01:00
test updated python SDK go.mod (#9723) 2022-05-28 12:08:13 -05:00
test_with_mocks [sdk/{nodejs,python}] Fix errors when testing remote components with mocks (#8053) 2021-09-24 06:08:13 -07:00
setup.py Update python requirments to pin to major version (#9711) 2022-05-27 12:54:40 +01:00