diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1f40749e..dbccacfc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -50,8 +50,8 @@ In general, try to replicate the coding style that is already present. Specifica ### 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. +For internal consistency, Ruma uses American spelling for variable names. Names may differ in the +serialized representation, as the Matrix specification has a mix of British and American English. ### Common Types diff --git a/crates/ruma/src/lib.rs b/crates/ruma/src/lib.rs index 5ab0adac..a8b88f17 100644 --- a/crates/ruma/src/lib.rs +++ b/crates/ruma/src/lib.rs @@ -10,8 +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. +//! > 🛈 For internal consistency, Ruma uses American spelling for variable names. Names may differ +//! > in the serialized representation, as the Matrix specification has a mix of British and +//! > American English. //! //! # API features //!