Переглянути джерело

Link doc lines to source specifications.

Jeroen van Rijn 2 днів тому
батько
коміт
236111864e

+ 1 - 3
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`.
 

+ 1 - 1
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.
 

+ 1 - 2
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

+ 1 - 1
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

+ 1 - 1
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`

+ 2 - 2
core/math/noise/opensimplex2.odin

@@ -1,7 +1,7 @@
 /*
-	`OpenSimplex2` noise algorithm.
+	[[ OpenSimplex2 ; https://github.com/KdotJPG/OpenSimplex2 ]] noise algorithm.
 
-	Ported from [[ https://github.com/KdotJPG/OpenSimplex2 }].
+	Ported from [[ https://github.com/KdotJPG/OpenSimplex2 ]].
 	Copyright 2022 Yuki2 [[ https://github.com/NoahR02 ]]
 */
 package math_noise