From 2b8e2f087ae7a854b90fa382b65fda6925bbd88f Mon Sep 17 00:00:00 2001 From: Jesse Wierzbinski Date: Sat, 27 Jul 2024 15:50:58 +0200 Subject: [PATCH] docs: :memo: Specify number precision validation in docs --- app/federation/validation/page.mdx | 3 +++ 1 file changed, 3 insertions(+) diff --git a/app/federation/validation/page.mdx b/app/federation/validation/page.mdx index 813205e..77ea277 100644 --- a/app/federation/validation/page.mdx +++ b/app/federation/validation/page.mdx @@ -25,6 +25,9 @@ Things that should be validated include, but are not limited to: - If you do set limits, they should be reasonable and well-documented. - The **type**, **precision** and **scale** of all numeric fields. - For example, a `size` field on a `ContentFormat` structure should be a positive integer, not a negative number or a floating-point number. + + All numeric fields in these docs have the appropriate precision (`u64`, `i64`, `f32`, etc.) specified. Do not use a different type in memory than the one specified in the docs. + - The **validity** of all URLs and URIs (run them through your favorite URL parser). - The **time** of all dates and times (people should not be born in the future, or in the year 0).