OSSForks/ladybird
1
0
Fork 0
mirror of https://github.com/zebrajr/ladybird.git synced 2025-12-06 00:19:53 +01:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

Docs: Prefer closely matching explicit spec AO names

Browse Source
This commit is contained in:
sideshowbarker 2025-02-25 14:24:52 +09:00 committed by Sam Atkins
parent 0d1ce48071
commit 18a160e0e9
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Documentation/CodingStyle.md
View File

@ -35,6 +35,22 @@ class Filedescriptor;
String MIME_Type();
```
When implementing spec algorithms and other constructs that a spec explicitly names, prefer closely matching the same names the spec uses, whenever possible.
Given the construct at https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#suffering-from-being-missing which has the literal name _“Suffering from being missing”_ in the spec, for example:
###### Right:
```c++
bool HTMLInputElement::suffering_from_being_missing(); // exactly matches the spec naming
```
###### Wrong:
```c++
bool HTMLInputElement::has_missing_constraint(); // arbitrarily differs from spec naming
```
Use full words, except in the rare case where an abbreviation would be more canonical and easier to understand.
###### Right: