corysanin/tubestation
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Bug 1923048 - [text], r=aryx

Browse Source 
Fix the warnings for the topic-guide docs by removing the not needed sync-group: language

Differential Revision: https://phabricator.services.mozilla.com/D225636
This commit is contained in:
Bastian Gruber
2024-10-16 11:01:55 +00:00
parent 76bcffc918
commit 9fdad334a8
2 changed files with 0 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/rust-components/topic-guides/relevancy.md
View File

@@ -12,8 +12,6 @@ The `relevancy` component tracks the user's interests locally, without sharing a
To use the `RelevancyStore` in either Kotlin or Swift, you need to import the relevant classes and data types from the `MozillaAppServices` library.
:::{tab-set-code}
:sync-group: language
```kotlin
import mozilla.appservices.relevancy.RelevancyStore
import mozilla.appservices.relevancy.InterestVector
@@ -33,7 +31,6 @@ let store = RelevancyStore(dbPath: "path/to/database")
To work with the RelevancyStore, you need to create an instance using a database path where the user’s interest data will be stored:
:::{tab-set-code}
:sync-group: language
```kotlin
val store = RelevancyStore(dbPath)
```
@@ -53,7 +50,6 @@ To build the user's interest vector, call the `ingest` function with a list of U
### Example usage of `ingest`:
:::{tab-set-code}
:sync-group: language
```kotlin
val topUrlsByFrequency = listOf("https://example.com", "https://another-example.com")
val interestVector = store.ingest(topUrlsByFrequency)

7
docs/rust-components/topic-guides/suggest.md
View File

@@ -21,7 +21,6 @@ The API for the `SuggestStore` can be found in the [MozillaComponents Kotlin doc
You need to import one or more of the following primitives to work with the `SuggestStore` (these come from the generated `suggest.kt` file, produced by `uniffi`):
:::{tab-set-code}
:sync-group: language
```kotlin
import mozilla.appservices.remotesettings.RemoteSettingsServer
@@ -41,7 +40,6 @@ import MozillaAppServices
Create a `SuggestStore` as a singleton. You do this via the `SuggestStoreBuilder`, which returns a `SuggestStore`. No I/O or network requests are performed during construction, which makes this safe to do at any point in the application startup:
:::{tab-set-code}
:sync-group: language
```kotlin
internal val store: SuggestStore = {
SuggestStoreBuilder()
@@ -76,7 +74,6 @@ Ingesting suggestions happens in two different ways: On startup, and then, perio
Ingest with `SuggestIngestionConstraints(emptyOnly=true)` shortly after each startup. This ensures we have something in the DB on the first run and also after upgrades where we often will clear the DB to start from scratch.
:::{tab-set-code}
:sync-group: language
```kotlin
store.value.ingest(SuggestIngestionConstraints(
emptyOnly = true,
@@ -97,7 +94,6 @@ store.value.ingest(SuggestIngestionConstraints(
Ingest with `SuggestIngestionConstraints(emptyOnly=false)` on a regular schedule (like once a day).
:::{tab-set-code}
:sync-group: language
```kotlin
store.value.ingest(SuggestIngestionConstraints(emptyOnly = false))
```
@@ -112,7 +108,6 @@ store.value.ingest(SuggestIngestionConstraints(emptyOnly: false))
Call `SuggestStore::query` to fetch suggestions for the suggest bar. The `providers` parameter should be the same value that got passed to `ingest()`.
:::{tab-set-code}
:sync-group: language
```kotlin
store.value.query(
SuggestionQuery(
@@ -139,7 +134,6 @@ store.value.query(
Call `SuggestStore::Interrupt` with `InterruptKind::Read` to interrupt any in-progress queries when the user cancels a query and before running the next query.
:::{tab-set-code}
:sync-group: language
```kotlin
store.value.interrupt()
```
@@ -154,7 +148,6 @@ store.value.interrupt()
On shutdown, call `SuggestStore::Interrupt` with `InterruptKind::ReadWrite` to interrupt any in-progress ingestion and queries.
:::{tab-set-code}
:sync-group: language
```kotlin
store.value.interrupt()
```