luxolus
/
open-consul
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity

docs: Add CodeBlockConfig to network coordinates page

This commit is contained in:
Anthony 2022-01-11 01:13:27 -05:00 committed by GitHub
parent a4d2dc0ce2
commit a217d13e1b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
website/content/docs/architecture/coordinates.mdx
View File

@ -48,14 +48,20 @@ Computing the estimated network round trip time between any two nodes is simple
once you have their coordinates. Here's a sample coordinate, as returned from the once you have their coordinates. Here's a sample coordinate, as returned from the
[Coordinate endpoint](/api/coordinate). [Coordinate endpoint](/api/coordinate).
<CodeBlockConfig heading="Sample coordinate from Coordinate endpoint" hideClipboard>
```json
...
"Coord": {
"Adjustment": 0.1,
"Error": 1.5,
"Height": 0.02,
"Vec": [0.34,0.68,0.003,0.01,0.05,0.1,0.34,0.06]
}
...
``` ```
"Coord": {
"Adjustment": 0.1, </CodeBlockConfig>
"Error": 1.5,
"Height": 0.02,
"Vec": [0.34,0.68,0.003,0.01,0.05,0.1,0.34,0.06]
}
```
All values are floating point numbers in units of seconds, except for the error All values are floating point numbers in units of seconds, except for the error
term which isn't used for distance calculations. term which isn't used for distance calculations.
@ -63,7 +69,9 @@ term which isn't used for distance calculations.
Here's a complete example in Go showing how to compute the distance between two Here's a complete example in Go showing how to compute the distance between two
coordinates: coordinates:
``` <CodeBlockConfig heading="Computing distance between two coordinates with Go">
```go
import ( import (
"math" "math"
"time" "time"
@ -97,3 +105,5 @@ func dist(a *coordinate.Coordinate, b *coordinate.Coordinate) time.Duration {
return time.Duration(rtt * secondsToNanoseconds) return time.Duration(rtt * secondsToNanoseconds)
} }
``` ```
</CodeBlockConfig>