Skip to content

Commit 6b5d529

Browse files
authored
updates
1 parent 4384113 commit 6b5d529

File tree

4 files changed

+17
-12
lines changed

4 files changed

+17
-12
lines changed
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
has_children: true
3+
---
4+
5+
# Best Practices

contributor-docs/components/dependencies.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -100,14 +100,14 @@ To declare a required dependency use the following in your `ComponentRegistrar`:
100100
The provider will return `null` if the dependency is not present in the app.
101101

102102
{: .warning }
103-
When the app uses [Play's dynamic feature delivery](https://developer.android.com/guide/playcore/feature-delivery),
104-
`provider.get()` can return your dependency when it becomes available, so be prepared for that.
105-
And don't store references to the result of `provider.get()` calls.
103+
> When the app uses [Play's dynamic feature delivery](https://developer.android.com/guide/playcore/feature-delivery),
104+
> `provider.get()` can return your dependency when it becomes available, so be prepared for that.
105+
> And don't store references to the result of `provider.get()` calls.
106106
107107
See [Dynamic Module Support]({{ site.baseurl }}{% link components/dynamic_modules.md %}) for details
108108

109109
{: .warning }
110-
See Deferred dependencies if you your dependency has a callback based apis
110+
> See Deferred dependencies if you your dependency has a callback based apis
111111
112112
## Deferred Dependencies
113113

@@ -169,10 +169,10 @@ To consume such a set the interested `Component` needs to declare a special kind
169169
set will get initialized.
170170

171171
{: .warning }
172-
Similar to optional `Provider` dependencies, where an optional dependency can become available at runtime due to
173-
[Play's dynamic feature delivery](https://developer.android.com/guide/playcore/feature-delivery),
174-
`Set` dependencies can change at runtime by new elements getting added to the set.
175-
So make sure to hold on to the original `Set` to be able to observe new values in it as they are added.
172+
> Similar to optional `Provider` dependencies, where an optional dependency can become available at runtime due to
173+
> [Play's dynamic feature delivery](https://developer.android.com/guide/playcore/feature-delivery),
174+
> `Set` dependencies can change at runtime by new elements getting added to the set.
175+
> So make sure to hold on to the original `Set` to be able to observe new values in it as they are added.
176176
177177
Example:
178178

contributor-docs/components/executors.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ Qualified<CoroutineDispatcher> dispatcher = qualified(Blocking::class.java, Coro
154154
#### Direct executor
155155

156156
{: .warning }
157-
Prefer `@Lightweight` instead of using direct executor as it could cause dead locks and stack overflows
157+
> Prefer `@Lightweight` instead of using direct executor as it could cause dead locks and stack overflows.
158158
159159
For any trivial tasks that don't need to run asynchronously
160160

contributor-docs/onboarding/new_sdk.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,9 @@ the library will have once released. e.g. `firebase-common` directory
4141
hosts code for the `com.google.firebase:firebase-common` SDK.
4242

4343
{: .warning }
44-
Note that the build file name for any given SDK is not `build.gradle` or `build.gradle.kts`
45-
but rather mirrors the name of the sdk, e.g.
46-
`firebase-common/firebase-common.gradle` or `firebase-common/firebase-common.gradle.kts`.
44+
> Note that the build file name for any given SDK is not `build.gradle` or `build.gradle.kts`
45+
> but rather mirrors the name of the sdk, e.g.
46+
> `firebase-common/firebase-common.gradle` or `firebase-common/firebase-common.gradle.kts`.
4747
4848
All of the core Gradle build logic lives in `buildSrc` and is used by all
4949
SDKs.

0 commit comments

Comments
 (0)