Skip to content
This repository was archived by the owner on Dec 18, 2018. It is now read-only.

Commit 596f8ac

Browse files
arturdryomovdavidfowl
authored andcommitted
Refine documentation formatting (#3080)
* Fix installation command formatting in the readme. * Add more syntax highlighting to JS test docs. * Add syntax highlighting to transport docs.
1 parent 55b9a53 commit 596f8ac

File tree

3 files changed

+5
-5
lines changed

3 files changed

+5
-5
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ npm install @aspnet/signalr --registry https://dotnet.myget.org/f/aspnetcore-dev
4848
We also have a MsgPack protocol library which is installed via:
4949

5050
```bash
51-
npm install @aspnet/signalr-protocol-msgpack
51+
npm install @aspnet/signalr-protocol-msgpack
5252
```
5353

5454
## Deploying

docs/JSUnitTests.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ Just make sure you remove `.only` when you finish running that test!
6666

6767
You can also use the `-t` parameter to jest. That parameter takes a substring pattern to match against all tests to see if they should run. To improve the speed of the run, you should pair this up with the argument that takes a file path to filter on. For example, given these tests
6868

69-
```
69+
```typescript
7070
describe("AbortSignal", () => {
7171
describe("aborted", () => {
7272
it("is false on initialization", () => {

specs/TransportProtocols.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ The `POST [endpoint-base]/negotiate` request is used to establish a connection b
2222

2323
1. A response that contains the `connectionId` which will be used to identify the connection on the server and the list of the transports supported by the server.
2424

25-
```
25+
```json
2626
{
2727
"connectionId":"807809a5-31bf-470d-9e23-afaee35d8a0d",
2828
"availableTransports":[
@@ -50,7 +50,7 @@ The `POST [endpoint-base]/negotiate` request is used to establish a connection b
5050

5151
2. A redirect response which tells the client which URL and optionally access token to use as a result.
5252

53-
```
53+
```json
5454
{
5555
"url": "https://myapp.com/chat",
5656
"accessToken": "accessToken"
@@ -65,7 +65,7 @@ The `POST [endpoint-base]/negotiate` request is used to establish a connection b
6565

6666
3. A response that contains an `error` which should stop the connection attempt.
6767

68-
```
68+
```json
6969
{
7070
"error": "This connection is not allowed."
7171
}

0 commit comments

Comments
 (0)