From ad22c12e05a7b43a02c8a4491719de8fc1fc5645 Mon Sep 17 00:00:00 2001
From: Anu <anulithic@gmail.com>
Date: Mon, 24 Feb 2025 17:15:51 -0800
Subject: [PATCH] Add typical use cases to function descriptions
---
src/js/utilsSlave.js | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/src/js/utilsSlave.js b/src/js/utilsSlave.js
index 6b3bf0cdcd9..3cc45175a18 100644
--- a/src/js/utilsSlave.js
+++ b/src/js/utilsSlave.js
@@ -1352,6 +1352,8 @@ App.Utils.setLocalPronouns = function(slave, suffix, pronouns) {
* Fix nationalities as adjectives
* @param {string} nation
* @returns {string}
+ *
+ * Typical use case: "You have acquired one ${aNational(slave.nationality)} slave"
*/
globalThis.aNational = function(nation) {
let country;
@@ -1373,6 +1375,8 @@ globalThis.aNational = function(nation) {
* Fix nationalities as plurals
* @param {string} nation
* @returns {string}
+ *
+ * Typical use case: "You have acquired three ${moreNational(slave.nationality)} slaves"
*/
globalThis.moreNational = function(nation) {
let country;
@@ -1398,6 +1402,8 @@ globalThis.moreNational = function(nation) {
* Translate nationalities into the common name of the nation
* @param {string} nation
* @returns {string}
+ *
+ * Typical use case: "Your new slave is a refugee from ${nationOf(slave.nationality)}"
*/
globalThis.nationOf = function(nation) {
let country;
--
GitLab