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

chore(remap): docs for the Remap type functions #6446

Merged
merged 14 commits into from
Feb 16, 2021
Merged

Conversation

StephenWakely
Copy link
Contributor

@StephenWakely StephenWakely commented Feb 15, 2021

This adds docs for the functions: array, bool, int, float, timestamp, object.

Also noted some errors with the parse_regex function docs - they raise an error if no match is found.

Have also been through the functions and updated the examples for any fallible functions to be called with an appended !.

Have updated the docs to refer to maps as objects.

Signed-off-by: Stephen Wakely <[email protected]>
Signed-off-by: Stephen Wakely <[email protected]>
Signed-off-by: Stephen Wakely <[email protected]>
@StephenWakely StephenWakely requested review from a team, JeanMertz and binarylogic and removed request for a team February 15, 2021 15:29
binarylogic and others added 7 commits February 15, 2021 10:39
Signed-off-by: binarylogic <[email protected]>
Signed-off-by: Stephen Wakely <[email protected]>
Signed-off-by: Stephen Wakely <[email protected]>
Signed-off-by: Stephen Wakely <[email protected]>
Signed-off-by: binarylogic <[email protected]>
@StephenWakely
Copy link
Contributor Author

@binarylogic Ok, I have removed the ! from the function calls in the examples. I have left it in the examples for the type functions that this PR is primarily about, since the whole point of these functions is to error if their parameter is the wrong type.

For example:

  format_timestamp(timestamp!(.timestamp), format: "%+")

The timestamp! call only makes sense because we are handling the error before passing it to format_timestamp.

Signed-off-by: binarylogic <[email protected]>
Signed-off-by: binarylogic <[email protected]>
Signed-off-by: binarylogic <[email protected]>
Signed-off-by: binarylogic <[email protected]>
@binarylogic binarylogic merged commit 3f1c5b8 into master Feb 16, 2021
@binarylogic binarylogic deleted the remap_type_docs branch February 16, 2021 20:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants