Skip to content

Commit ac6a9f5

Browse files
Merge pull request #2988 from DataDog/apply-readme-heading-fixes
Apply readme suggestions Co-authored-by: typotter <[email protected]>
2 parents 6fc42d0 + a6f4431 commit ac6a9f5

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

features/dd-sdk-android-flags/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
The Datadog Feature Flags SDK for Android allows you to evaluate feature flags and experiments in your Android application and automatically send flag evaluation data to Datadog for monitoring and analysis.
44

5-
## Getting Started
5+
## Getting started
66

77
Add the Datadog Feature Flags SDK to your application's `build.gradle` file:
88

@@ -15,7 +15,7 @@ dependencies {
1515
}
1616
```
1717

18-
### Initial Setup
18+
### Initial setup
1919

2020
Before enabling the Feature Flags feature, you must first initialize the Datadog SDK. See the [Datadog Android SDK setup documentation][1] for details.
2121

@@ -70,7 +70,7 @@ val flagsConfig = FlagsConfiguration.Builder()
7070
.build()
7171
```
7272

73-
**Note:** This setting only has an effect if you have enabled RUM (see [Initial Setup](#initial-setup) section). If RUM is not enabled, flag evaluations are not sent to RUM regardless of this setting.
73+
**Note:** This setting only has an effect if you have enabled RUM (see [Initial setup](#initial-setup) section). If RUM is not enabled, flag evaluations are not sent to RUM regardless of this setting.
7474

7575
#### Disable exposure tracking
7676

@@ -217,7 +217,7 @@ if (result.errorCode != null) {
217217
- `errorMessage: String?` - Optional human-readable error message
218218
- `flagMetadata: Map<String, Any>?` - Optional metadata associated with the flag
219219

220-
##### Error Codes
220+
##### Error codes
221221
- `FLAG_NOT_FOUND` - The flag could not be found
222222
- `PARSE_ERROR` - Error parsing the flag value
223223
- `TYPE_MISMATCH` - The flag type doesn't match the expected type
@@ -227,7 +227,7 @@ if (result.errorCode != null) {
227227
- `PROVIDER_FATAL` - The provider encountered a fatal error
228228
- `GENERAL` - A general error occurred
229229

230-
### Retrieving existing clients
230+
### Retrieve existing clients
231231

232232
You can retrieve a previously created client by name:
233233

@@ -250,9 +250,9 @@ When RUM is enabled in your application and RUM integration is enabled in the Fl
250250

251251
This allows you to correlate feature flag usage with application performance, errors, and user behavior.
252252

253-
## Prerequisites for RUM Integration
253+
## Prerequisites for RUM integration
254254
1. Add the `dd-sdk-android-rum` dependency to your project
255-
2. Enable RUM before initializing the Flags feature (see [Initial Setup](#initial-setup) section)
255+
2. Enable RUM before initializing the Flags feature (see [Initial setup](#initial-setup) section)
256256
3. Ensure `rumIntegrationEnabled` is set to `true` in your `FlagsConfiguration` (this is the default)
257257

258258
If RUM is not enabled, the Flags SDK will continue to work normally, but flag evaluations will not appear in RUM views.

0 commit comments

Comments
 (0)