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

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

Open
saltiyazan opened this issue Sep 8, 2023 · 0 comments
Labels
wishlisted requested feature

Comments

@saltiyazan
Copy link

saltiyazan commented Sep 8, 2023

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
@saltiyazan saltiyazan added the wishlisted requested feature label Sep 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
wishlisted requested feature
Projects
None yet
Development

No branches or pull requests

1 participant