Fix a couple Vale linter warnings

2022-12-06 15:41:05 +01:00
parent dbbb2f26be
commit a338b9b95f
67 changed files with 303 additions and 303 deletions
@@ -16,7 +16,7 @@ which allows you persist data locally which works with all packages.

 ### How do I choose?

-#### The case for stream_chat_flutter
+#### The case for `stream_chat_flutter`

 For the quickest way to integrate Stream Chat with your app, the UI SDK (`stream_chat_flutter`) is the
 way to go. `stream_chat_flutter` contains prebuilt components that manage most operations like data
@@ -32,26 +32,26 @@ to request this through our support channels.

 <b>Summary:</b>

-For the quickest and easiest way to add Chat to your app with prebuilt UI components, use stream_chat_flutter
+For the quickest and easiest way to add Chat to your app with prebuilt UI components, use `stream_chat_flutter`


-#### The case for stream_chat_flutter_core
+#### The case for `stream_chat_flutter_core`

-If your application involves UI that does not fit in with the stream_chat_flutter components, stream_chat_flutter_core
+If your application involves UI that does not fit in with the `stream_chat_flutter` components, `stream_chat_flutter_core`
 strips away the UI associated with the components and provides the data fetching and manipulation
 capabilities while supplying builders for UI. This allows you to implement your own UI and themes
 completely independently while not worrying about writing functions for data and pagination.

 <b>Summary:</b>

-For implementing your own custom UI while not having to worry about lower level API calls, use stream_chat_flutter_core.
+For implementing your own custom UI while not having to worry about lower level API calls, use `stream_chat_flutter_core`.

-#### The case for stream_chat
+#### The case for `stream_chat`

-The stream_chat package is the Low-level Client (LLC) of Stream Chat in Flutter. This package wraps
+The `stream_chat` package is the Low-level Client (LLC) of Stream Chat in Flutter. This package wraps
 the underlying functionality of Stream Chat and allows the most customization in terms of UI, data,
 and architecture.

 <b>Summary:</b>

-For the most control over the SDK and dealing with low level calls to the API, use stream_chat.
+For the most control over the SDK and dealing with low level calls to the API, use `stream_chat`.
@@ -20,18 +20,18 @@ giving you complete control to ones that give you a rich out-of-the-box chat exp

 The packages that make up the Stream Chat SDK are:

-1. <b>Low Level Client (stream_chat)</b>: a pure Dart package that can be used on any Dart project.
+1. <b>Low Level Client (`stream_chat`)</b>: a pure Dart package that can be used on any Dart project.
 It provides a low-level client to access the Stream Chat service.
-2. <b>Core (stream_chat_flutter_core)</b>: provides business logic to fetch common things required
+2. <b>Core (`stream_chat_flutter_core`)</b>: provides business logic to fetch common things required
 for integrating Stream Chat into your application.
 The core package allows more customisation and hence provides business logic but no UI components.
-3. <b>UI (stream_chat_flutter)</b>: this library includes both a low-level chat SDK and a set of
-reusable and customisable UI components.
-4. <b>Persistence (stream_chat_persistence)</b>: provides a persistence client for fetching and
+3. <b>UI (`stream_chat_flutter`)</b>: this library includes both a low-level chat SDK and a set of
+reusable and customizable UI components.
+4. <b>Persistence (`stream_chat_persistence`)</b>: provides a persistence client for fetching and
 saving chat data locally.
-5. <b>Localizations (stream_chat_localizations)</b>: provides a set of localizations for the SDK.
+5. <b>Localizations (`stream_chat_localizations`)</b>: provides a set of localizations for the SDK.

-We recommend building prototypes using the full UI package, [stream_chat_flutter](https://pub.dev/packages/stream_chat_flutter),
+We recommend building prototypes using the full UI package, [`stream_chat_flutter`](https://pub.dev/packages/stream_chat_flutter),
 since it contains UI widgets already integrated with Stream's API. It is the fastest way to get up
 and running using Stream chat in your app.

@@ -39,7 +39,7 @@ The Flutter SDK enables you to build any type of chat or messaging experience fo
 and Desktop.

 If you're building a very custom UI and would prefer a more lean package,
-[stream_chat_flutter_core](https://pub.dev/packages/stream_chat_flutter_core) will be suited to this
+[`stream_chat_flutter_core`](https://pub.dev/packages/stream_chat_flutter_core) will be suited to this
 use case. Core allows you to build custom, expressive UIs while retaining the benefits of our full
 Flutter SDK. APIs for accessing and controlling users, sending messages, and so forth are seamlessly integrated
 into this package and accessible via providers and builders.
@@ -69,7 +69,7 @@ While this is a simplistic overview of the service, the Flutter SDK handles the

 Before reading the docs, consider trying our [online API tour](https://getstream.io/chat/get_started/),
 it is a nice way to learn how the API works.
-It's in-browser so you'll need to use Javascript but the core conceps are pretty much the same as Dart.
+It's in-browser so you'll need to use JavaScript but the core concepts are pretty much the same as Dart.

 You may also like to look at the [Flutter tutorial](https://getstream.io/chat/flutter/tutorial/)
 which focuses on using the UI package to get Stream Chat integrated into a Flutter app.
@@ -4,7 +4,7 @@ sidebar_position: 3
 title: Versioning Policy
 ---

-All of the Stream Chat packages follow [semantic versioning (semver)](https://semver.org/).
+All of the Stream Chat packages follow [semantic versioning](https://semver.org/).

 That means that with a version number x.y.z (major.minor.patch):
 - When releasing bug fixes (backwards compatible), we make a patch release by changing the z number (ex: 3.6.2 to 3.6.3). A bug fix is defined as an internal change that fixes incorrect behavior.