juju / python-libjuju

Python library for the Juju API
Apache License 2.0
59 stars 99 forks source link

Improve documentation of async def run_action(self, action_name, **params): in Read The Docs #948

Open saltiyazan opened 1 year ago

saltiyazan commented 1 year ago

Description

Hi,

Could you please improve the docstring of async def run_action(self, action_name, **params): function in Read the Docs?

In particular :param **params: Action parameters in the docstring. It would be useful to mention that the action parameters can be passed in a dictionary for keys that aren't valid python descriptors. For example:

action = await my_action.run_action(
        action_name="my-action",
        **{
            "relation-id": relation_id,
            "key-1": "value",
            "key2": "value",
        },
    )

Urgency

Casually wishlisting

Code I'd Like to Run

None
github-actions[bot] commented 2 months ago

This issue is marked as incomplete because it has been open 30 days with no activity. Please remove incomplete label or comment or this will be closed in 5 days.

github-actions[bot] commented 2 months ago

This issue was closed because it has been stalled for 5 days with no activity.

hmlanigan commented 1 month ago

Closed prematurely by the bot.