Format markdown files (dart-lang/sse#68)
diff --git a/pkgs/sse/CHANGELOG.md b/pkgs/sse/CHANGELOG.md index 9a96173..16378c5 100644 --- a/pkgs/sse/CHANGELOG.md +++ b/pkgs/sse/CHANGELOG.md
@@ -30,8 +30,8 @@ ## 3.8.1 -- Fix an issue where closing the `SseConnection` stream would result in - an error. +- Fix an issue where closing the `SseConnection` stream would result in an + error. ## 3.8.0 @@ -41,8 +41,8 @@ ## 3.7.0 -- Deprecate the client's `onOpen` getter. Messages will now be buffered until - a connection is established. +- Deprecate the client's `onOpen` getter. Messages will now be buffered until a + connection is established. ## 3.6.1 @@ -53,15 +53,14 @@ - Improve performance by buffering out of order messages in the server instead of the client. -** Note ** This is not modelled as a breaking change as the server can handle -messages from older clients. However, clients should be using the latest server -if they require order guarantees. - +\*\* Note \*\* This is not modelled as a breaking change as the server can +handle messages from older clients. However, clients should be using the latest +server if they require order guarantees. ## 3.5.0 -- Add new `shutdown` methods on `SseHandler` and `SseConnection` to allow closing - connections immediately, ignoring any keep-alive periods. +- Add new `shutdown` methods on `SseHandler` and `SseConnection` to allow + closing connections immediately, ignoring any keep-alive periods. ## 3.4.0 @@ -70,14 +69,14 @@ ## 3.3.0 -- Add an `onClose` event to the `SseConnection`. This allows consumers to - listen to this event in lue of `sseConnection.sink.done` as that is not - guaranteed to fire. +- Add an `onClose` event to the `SseConnection`. This allows consumers to listen + to this event in lue of `sseConnection.sink.done` as that is not guaranteed to + fire. ## 3.2.2 -- Fix an issue where `keepAlive` may cause state errors when attempting to - send messages on a closed stream. +- Fix an issue where `keepAlive` may cause state errors when attempting to send + messages on a closed stream. ## 3.2.1 @@ -99,21 +98,21 @@ - Make `isInKeepAlive` on `SseConnection` private. **Note that this is a breaking change but in actuality no one should be - depending on this API.** +depending on this API.** ## 3.1.0 - Add optional `keepAlive` parameter to the `SseHandler`. If `keepAlive` is - supplied, the connection will remain active for this period after a - disconnect and can be reconnected transparently. If there is no reconnect - within that period, the connection will be closed normally. + supplied, the connection will remain active for this period after a disconnect + and can be reconnected transparently. If there is no reconnect within that + period, the connection will be closed normally. ## 3.0.0 - Add retry logic. -**Possible Breaking Change Error messages may now be delayed up to 5 seconds - in the client.** +**Possible Breaking Change Error messages may now be delayed up to 5 seconds in +the client.** ## 2.1.2 @@ -150,7 +149,6 @@ - Internal cleanup. - ## 0.0.1 - Initial commit.
diff --git a/pkgs/sse/CONTRIBUTING.md b/pkgs/sse/CONTRIBUTING.md index 6f5e0ea..069477c 100644 --- a/pkgs/sse/CONTRIBUTING.md +++ b/pkgs/sse/CONTRIBUTING.md
@@ -2,6 +2,7 @@ the end). ### Before you contribute + Before we can use your code, you must sign the [Google Individual Contributor License Agreement](https://cla.developers.google.com/about/google-individual) (CLA), which you can do online. The CLA is necessary mainly because you own the @@ -18,16 +19,21 @@ frustration later on. ### Code reviews + All submissions, including submissions by project members, require review. ### File headers + All files in the project must start with the following header. - // Copyright (c) 2015, the Dart project authors. Please see the AUTHORS file - // for details. All rights reserved. Use of this source code is governed by a - // BSD-style license that can be found in the LICENSE file. +``` +// Copyright (c) 2015, the Dart project authors. Please see the AUTHORS file +// for details. All rights reserved. Use of this source code is governed by a +// BSD-style license that can be found in the LICENSE file. +``` ### The small print + Contributions made by corporations are covered by a different agreement than the one above, the [Software Grant and Corporate Contributor License Agreement](https://developers.google.com/open-source/cla/corporate).
diff --git a/pkgs/sse/README.md b/pkgs/sse/README.md index f5c1f80..367219c 100644 --- a/pkgs/sse/README.md +++ b/pkgs/sse/README.md
@@ -2,13 +2,13 @@ [](https://pub.dev/packages/sse) [](https://pub.dev/packages/sse/publisher) -This package provides support for bi-directional communication through -Server Sent Events and corresponding POST requests. +This package provides support for bi-directional communication through Server +Sent Events and corresponding POST requests. -This package is not intended to be a general purpose SSE package, but instead -is a bidirectional protocol for use when Websockets are unavailable. -That is, both the client and the server expose a `sink` and `stream` on which to send -and receive messages respectively. +This package is not intended to be a general purpose SSE package, but instead is +a bidirectional protocol for use when Websockets are unavailable. That is, both +the client and the server expose a `sink` and `stream` on which to send and +receive messages respectively. -Both the server and client have implicit assumptions on each other and therefore a -client from this package must be paired with a server from this package. +Both the server and client have implicit assumptions on each other and therefore +a client from this package must be paired with a server from this package.