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

docs(parameters): auto-transforming values based on suffix #573

Merged
merged 3 commits into from
Aug 10, 2021

Conversation

dreamorosi
Copy link
Contributor

Issue #, if available:
#562

Description of changes:

Added subsection under "Utilities > Parameters > Advanced > Deserializing values with transform parameter" titled "Infer transform from parameter suffix with get_multiple()" to document auto transform behaviour.

Checklist

Breaking change checklist

RFC issue #:

  • Migration process documented
  • Implement warnings (if it can live side by side)

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@dreamorosi dreamorosi requested a review from heitorlessa July 29, 2021 12:32
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Jul 29, 2021
@pull-request-size pull-request-size bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jul 29, 2021
@boring-cyborg
Copy link

boring-cyborg bot commented Jul 29, 2021

Thanks a lot for your first contribution! Please check out our contributing guidelines and don't hesitate to ask whatever you need.

@codecov-commenter
Copy link

codecov-commenter commented Jul 29, 2021

Codecov Report

Merging #573 (847ce3b) into develop (1135314) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff            @@
##           develop     #573   +/-   ##
========================================
  Coverage    99.86%   99.86%           
========================================
  Files          113      113           
  Lines         4485     4485           
  Branches       243      243           
========================================
  Hits          4479     4479           
  Misses           3        3           
  Partials         3        3           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1135314...847ce3b. Read the comment docs.

"b.binary": [some value]
}
```
````
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and then remove this one?

Copy link
Contributor

@michaelbrewer michaelbrewer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good, just some formatting issue

@dreamorosi
Copy link
Contributor Author

Fixed both formatting issues, thanks for the review

@michaelbrewer
Copy link
Contributor

@heitorlessa - don't forget to have a look at this one :)

@heitorlessa
Copy link
Contributor

heitorlessa commented Aug 4, 2021

yep I have not. I need to revisit the wording on that sub-section. I think we can improve there but unsure what to suggest now.

Once I finish the Feature Flags PR (refactoring+docs), I'll get back to this. This + another PR to be created to make Tracer disabled by default in non-Lambda environments, before I cut the 1.19.0 release

@heitorlessa heitorlessa changed the title docs: Document auto transform feature in parameters get_multiple() docs(parameters): document auto-transforming values based on suffix Aug 10, 2021
@heitorlessa
Copy link
Contributor

Thanks a lot everyone - made minor changes to make it easier to find in the docs. Merging!

@heitorlessa heitorlessa changed the title docs(parameters): document auto-transforming values based on suffix docs(parameters): auto-transforming values based on suffix Aug 10, 2021
@heitorlessa heitorlessa merged commit 0b0b38b into develop Aug 10, 2021
@heitorlessa heitorlessa deleted the docs/parameters-transform-auto branch August 10, 2021 19:16
@boring-cyborg
Copy link

boring-cyborg bot commented Aug 10, 2021

Awesome work, congrats on your first merged pull request and thank you for helping improve everyone's experience!

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 size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants