chris/ruwuma
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

docs: Document the use of American spelling

Browse Source
This commit is contained in:
Kévin Commaille 2022-06-12 14:12:22 +02:00 committed by Kévin Commaille
parent cf3aee33f4
commit 251c1c85d2
2 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
CONTRIBUTING.md
View File

@ -48,6 +48,11 @@ help you on your way:
In general, try to replicate the coding style that is already present. Specifically: 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 ### Common Types
When writing endpoint definitions, use the following mapping from request / When writing endpoint definitions, use the following mapping from request /

3
crates/ruma/src/lib.rs
View File

@ -10,6 +10,9 @@
//! > ⚠ Some details might be missing because rustdoc has trouble with re-exports so you may need //! > ⚠ Some details might be missing because rustdoc has trouble with re-exports so you may need
//! > to refer to other crates' documentations. //! > 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 //! # API features
//! //!
//! Depending on which parts of Matrix are relevant to you, activate the following features: //! Depending on which parts of Matrix are relevant to you, activate the following features: