diff options
| author | Jeroen van Rijn <Kelimion@users.noreply.github.com> | 2025-10-10 18:29:52 +0200 |
|---|---|---|
| committer | Jeroen van Rijn <Kelimion@users.noreply.github.com> | 2025-10-10 18:29:52 +0200 |
| commit | 236111864ec8147acf73ce4db1ef3310205cac7a (patch) | |
| tree | efaf5b37d7814c59f2d31c19cfb15485f864adc7 /core/encoding | |
| parent | 998fbdc5c028f57619e58bda69819d131692b800 (diff) | |
Link doc lines to source specifications.
Diffstat (limited to 'core/encoding')
| -rw-r--r-- | core/encoding/base32/base32.odin | 4 | ||||
| -rw-r--r-- | core/encoding/cbor/doc.odin | 2 | ||||
| -rw-r--r-- | core/encoding/csv/doc.odin | 3 | ||||
| -rw-r--r-- | core/encoding/json/types.odin | 2 | ||||
| -rw-r--r-- | core/encoding/uuid/doc.odin | 2 |
5 files changed, 5 insertions, 8 deletions
diff --git a/core/encoding/base32/base32.odin b/core/encoding/base32/base32.odin index f50db12b3..34de2ff53 100644 --- a/core/encoding/base32/base32.odin +++ b/core/encoding/base32/base32.odin @@ -1,7 +1,5 @@ /* -`Base32` encoding and decoding, as specified in `RFC 4648`. - -[[ RFC 4648; https://www.rfc-editor.org/rfc/rfc4648.html ]] +`Base32` encoding and decoding, as specified in [[ RFC 4648; https://www.rfc-editor.org/rfc/rfc4648.html ]]. A secondary param can be used to supply a custom alphabet to `encode` and a matching decoding table to `decode`. diff --git a/core/encoding/cbor/doc.odin b/core/encoding/cbor/doc.odin index 4967a079a..370c5aaa9 100644 --- a/core/encoding/cbor/doc.odin +++ b/core/encoding/cbor/doc.odin @@ -1,5 +1,5 @@ /* -Encodes and decodes types from/into `RCF 8949` compatible `CBOR` binary. +Encodes and decodes types from/into [[ RCF 8949; https://www.rfc-editor.org/rfc/rfc8949.html ]] compatible `CBOR` binary. Also provided are conversion to and from JSON and the CBOR diagnostic format. diff --git a/core/encoding/csv/doc.odin b/core/encoding/csv/doc.odin index 2b9fdd849..50b8e3d1a 100644 --- a/core/encoding/csv/doc.odin +++ b/core/encoding/csv/doc.odin @@ -1,6 +1,5 @@ /* -Reader and writer for comma-separated values (`CSV`) files, per `RFC 4180`. -This package supports the format described in [[ RFC 4180; https://tools.ietf.org/html/rfc4180.html ]] +Reader and writer for comma-separated values (`CSV`) files, per [[ RFC 4180 ; https://tools.ietf.org/html/rfc4180.html ]]. Example: package main diff --git a/core/encoding/json/types.odin b/core/encoding/json/types.odin index 75a66f646..1da17a0db 100644 --- a/core/encoding/json/types.odin +++ b/core/encoding/json/types.odin @@ -1,5 +1,5 @@ /* -Encoding and decoding JSON in strict `JSON`, `JSON5` and `BitSquid` variants. +Encoding and decoding JSON in strict `JSON`, [[ JSON5 ; https://json5.org/ ]] and [[ BitSquid ; https://bitsquid.blogspot.com/2009/10/simplified-json-notation.html ]] variants. Using one of these `Specification`s. JSON diff --git a/core/encoding/uuid/doc.odin b/core/encoding/uuid/doc.odin index c2622c56b..a5f01ca7c 100644 --- a/core/encoding/uuid/doc.odin +++ b/core/encoding/uuid/doc.odin @@ -1,5 +1,5 @@ /* -Universally Unique Identifiers (`UUID`) according to `RFC 4122`, with additions from `RFC 9562`. +Universally Unique Identifiers (`UUID`) according to [[ RFC 4122 ; https://tools.ietf.org/html/rfc4122.html ]], with additions from [[ RFC 9562 ; https://tools.ietf.org/html/rfc9562.html ]]. The UUIDs are textually represented and read in the following string format: `00000000-0000-v000-V000-000000000000` |