From b6d3ed3aec0b0a0341f53ded689d909770d20f4d Mon Sep 17 00:00:00 2001 From: anothersimulacrum Date: Mon, 17 Jun 2024 20:32:39 +0530 Subject: [PATCH] Add some examples for rule #1 in gun naming (#74577) Add example, clarify some wording, and link to the name of the test in the script that enforces it. --- doc/GUN_NAMING_AND_INCLUSION.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/doc/GUN_NAMING_AND_INCLUSION.md b/doc/GUN_NAMING_AND_INCLUSION.md index 64c719a1135f2..fd443719ef8e7 100644 --- a/doc/GUN_NAMING_AND_INCLUSION.md +++ b/doc/GUN_NAMING_AND_INCLUSION.md @@ -139,14 +139,18 @@ There are two rules for the default names of guns. That is, the names of guns when the 'Gun Brand Names' option is not enabled. These rules are enforced by script. -## Rule 1: What is this? +## Rule 1 (Descriptive Names): What is this? This rule requires that the name of the gun clarifies what it is. This is meant to prevent gun names that are obscure strings of letters and numbers. +Guns that follow this rule will have names like `Glock pistol`, `m4 carbine`, +or `UMP submachine gun`. Guns that don't will have names like `FS2000`, +`SIG P226`, `Ruger LCR .38`, or `Taurus Raging Bull`. + As of writing, names are considered to be acceptable if the gun name contains -any of these strings. As with the other rules, the most up-to-date info on what -is acceptable is contained in the +any of these strings that describe that it is a gun and it's role. As with the +other rules, the most up-to-date info on what is acceptable is contained in the [verification script](../tools/json_tools/gun_variant_validator.py). | String |Reason| @@ -179,7 +183,7 @@ is acceptable is contained in the |submachine gun |describes a class of gun| |trenchgun |describes a class of gun| -## Rule 2: What goes with this? +## Rule 2 (Identifier Check): What goes with this? This rule requires that there is a common "identifier" string shared between the gun and all the magazines or speedloaders it takes.