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

[Maintenance] Parameters: transform: auto #562

Closed
dreamorosi opened this issue Jul 24, 2021 · 4 comments
Closed

[Maintenance] Parameters: transform: auto #562

dreamorosi opened this issue Jul 24, 2021 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@dreamorosi
Copy link
Contributor

What were you initially searching for in the docs?

Studying the Parameters BaseClass implementation I noticed that the get_multiple() method accepts also a value equal to auto.

This value is documented only in the docstring of the method but not on the actual documentation.

Is this related to an existing part of the documentation? Please share a link

https://awslabs.github.io/aws-lambda-powertools-python/latest/utilities/parameters/

Describe how we could make it clearer

Add the parameter to the documentation.

If you have a proposed update, please share it here

Happy to help with documenting this.

@dreamorosi dreamorosi added the documentation Improvements or additions to documentation label Jul 24, 2021
@boring-cyborg
Copy link

boring-cyborg bot commented Jul 24, 2021

Thanks for opening your first issue here! We'll come back to you as soon as we can.

@heitorlessa
Copy link
Contributor

heitorlessa commented Jul 24, 2021 via email

@dreamorosi dreamorosi self-assigned this Jul 24, 2021
@michaelbrewer
Copy link
Contributor

@dreamorosi - it is worth looking at the test cases. I worked on this feature, but definitely missed out on clear docs for it

@heitorlessa
Copy link
Contributor

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

No branches or pull requests

3 participants