From 251c1c85d2e532d44924a866661114ea7e727c19 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?K=C3=A9vin=20Commaille?= Date: Sun, 12 Jun 2022 14:12:22 +0200 Subject: [PATCH] docs: Document the use of American spelling --- CONTRIBUTING.md | 5 +++++ crates/ruma/src/lib.rs | 3 +++ 2 files changed, 8 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 83b5265c..1f40749e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -48,6 +48,11 @@ help you on your way: In general, try to replicate the coding style that is already present. Specifically: +### Naming + +For internal consistency, ruma uses American spelling for variable names. Actual values may differ, +as the matrix specification has a mix of British and American English. + ### Common Types When writing endpoint definitions, use the following mapping from request / diff --git a/crates/ruma/src/lib.rs b/crates/ruma/src/lib.rs index d25e44cf..a8fd17ac 100644 --- a/crates/ruma/src/lib.rs +++ b/crates/ruma/src/lib.rs @@ -10,6 +10,9 @@ //! > ⚠ Some details might be missing because rustdoc has trouble with re-exports so you may need //! > to refer to other crates' documentations. //! +//! > 🛈 For internal consistency, ruma uses American spelling for variable names. Actual values may +//! > differ, as the matrix specification has a mix of British and American English. +//! //! # API features //! //! Depending on which parts of Matrix are relevant to you, activate the following features: