RUMF-1497 Update logger API documentation #2098
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bcaudan
approved these changes
Mar 22, 2023
| @@ -148,7 +148,7 @@ Options that must have a matching configuration when using the `RUM` SDK: | |||
| After the Datadog browser logs SDK is initialized, send a custom log entry directly to Datadog with the API: | |||
|
|
|||
| ``` | |||
| logger.debug | info | warn | error (message: string, messageContext = Context) | |||
| logger.debug | info | warn | error (message: string, messageContext?: Context, error?: Error) | |||
There was a problem hiding this comment.
💬 suggestion: it could be nice to fix the signature in the onboarding snippet as well, cf https://app.datadoghq.com/logs/onboarding/client
cswatt
reviewed
Mar 22, 2023
4 tasks
maycmlee
approved these changes
Mar 27, 2023
yannickadam
deleted the
yannick.adam/RUMF-1497-logger-error-documentation-update
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Follow-up to #2029
Update documentation about new
errorparameter.Changes
genericlogger function section to include errorsI have gone over the contributing documentation.