docs(definitions): minor formatting to definitions' types (#1172)

13 files changed, 82 insertions, 30 deletions

diff --git a/src/definitions/address.ts b/src/definitions/address.ts
index 49ccb405..ad3bd319 100644
--- a/src/definitions/address.ts
+++ b/src/definitions/address.ts
@@ -8,8 +8,9 @@ export type AddressDefinitions = LocaleEntry<{
    * Postcodes patterns by state
    */
   postcode_by_state: { [state: string]: { min: number; max: number } };
+
   /**
-   * Postcodes patterns (Fake-Pattern | Fake-Pattern[]).
+   * Postcodes patterns.
    */
   postcode: string | string[];
 
@@ -17,44 +18,51 @@ export type AddressDefinitions = LocaleEntry<{
    * The patterns to generate city names.
    */
   city: string[];
+
   /**
    * The names of actual cities.
    */
   city_name: string[];
+
   /**
-   * Common city prefixes
+   * Common city prefixes.
    */
   city_prefix: string[];
+
   /**
-   * Common city suffixes
+   * Common city suffixes.
    */
   city_suffix: string[];
 
   /**
-   * The names of all countries
+   * The names of all countries.
    */
   country: string[];
+
   /**
-   * The names of this country's states
+   * The names of this country's states.
    */
   state: string[];
+
   /**
-   * The abbreviated names of this country's states
+   * The abbreviated names of this country's states.
    */
   state_abbr: string[];
+
   /**
-   * The names of counties inside the country or state
+   * The names of counties inside the country or state.
    */
   county: string[];
 
   /**
    * The names of the compass directions.
-   * First the 4 cardinal directions, then the 4 ordinal directions
+   * First the 4 cardinal directions, then the 4 ordinal directions.
    */
   direction: string[];
+
   /**
    * The abbreviated names of the compass directions.
-   * First the 4 cardinal directions, then the 4 ordinal directions
+   * First the 4 cardinal directions, then the 4 ordinal directions.
    */
   direction_abbr: string[];
 
@@ -67,16 +75,19 @@ export type AddressDefinitions = LocaleEntry<{
    * The patterns to generate street names.
    */
   street: string[];
+
   /**
    * The names of actual streets.
    */
   street_name: string[];
+
   /**
-   * Common street prefixes
+   * Common street prefixes.
    */
   street_prefix: string[];
+
   /**
-   * Common street suffixes
+   * Common street suffixes.
    */
   street_suffix: string[];
 
@@ -88,6 +99,7 @@ export type AddressDefinitions = LocaleEntry<{
      * The fake pattern to generate only the street address.
      */
     normal: string;
+
     /**
      * The fake pattern to generate the full street address including the secondary address.
      */
@@ -103,11 +115,14 @@ export type AddressDefinitions = LocaleEntry<{
    * The ISO-3166-1 ALPHA-2 country codes related to this locale.
    */
   country_code: string[];
+
   /**
    * The ISO-3166-1 ALPHA-3 country codes related to this locale.
    */
   country_code_alpha_3: string[];
 
-  // A list of timezones names.
+  /**
+   * A list of timezones names.
+   */
   time_zone: string[];
 }>;
diff --git a/src/definitions/color.ts b/src/definitions/color.ts
index a5bbd282..fbc34b33 100644
--- a/src/definitions/color.ts
+++ b/src/definitions/color.ts
@@ -1,13 +1,14 @@
 import type { LocaleEntry } from './definitions';
 
 /**
- * The possible definitions related to color.
+ * The possible definitions related to colors.
  */
 export type ColorDefinitions = LocaleEntry<{
   /**
-   * Human readable color names
+   * Human readable color names.
    */
   human: string[];
+
   /**
    * Color space names.
    */
diff --git a/src/definitions/commerce.ts b/src/definitions/commerce.ts
index 8157c1fc..bde1e849 100644
--- a/src/definitions/commerce.ts
+++ b/src/definitions/commerce.ts
@@ -8,10 +8,12 @@ export type CommerceDefinitions = LocaleEntry<{
    * Department names inside a shop.
    */
   department: string[];
+
   /**
    * Product name generation definitions.
    */
   product_name: CommerceProductNameDefinitions;
+
   /**
    * Descriptions for products.
    */
@@ -26,10 +28,12 @@ export interface CommerceProductNameDefinitions {
    * Adjectives describing a product (e.g. tasty).
    */
   adjective: string[];
+
   /**
    * Materials describing a product (e.g. wood).
    */
   material: string[];
+
   /**
    * Types of products (e.g. chair).
    */
diff --git a/src/definitions/company.ts b/src/definitions/company.ts
index 5b98bcc5..946d224b 100644
--- a/src/definitions/company.ts
+++ b/src/definitions/company.ts
@@ -8,28 +8,34 @@ export type CompanyDefinitions = LocaleEntry<{
    * Business/products related adjectives.
    */
   bs_adjective: string[];
+
   /**
    * Business/products related nouns.
    */
   bs_noun: string[];
+
   /**
    * Business/products related verbs.
    */
   bs_verb: string[];
+
   /**
-   * Catch phrase adjectives.
+   * Catchphrase adjectives.
    */
   adjective: string[];
+
   /**
-   * Catch phrase adjectives.
+   * Catchphrase adjectives.
    */
   descriptor: string[];
+
   /**
-   * Catch phrase adjectives.
+   * Catchphrase adjectives.
    */
   noun: string[];
+
   /**
-   * Company suffixes
+   * Company suffixes.
    */
   suffix: string[];
 }>;
diff --git a/src/definitions/database.ts b/src/definitions/database.ts
index 776f5361..aff9c334 100644
--- a/src/definitions/database.ts
+++ b/src/definitions/database.ts
@@ -5,19 +5,22 @@ import type { LocaleEntry } from './definitions';
  */
 export type DatabaseDefinitions = LocaleEntry<{
   /**
-   * Database Engine
+   * Database engines.
    */
   engine: string[];
+
   /**
-   * Database Collation
+   * Database collations.
    */
   collation: string[];
+
   /**
-   * Column names
+   * Column names.
    */
   column: string[];
+
   /**
-   * Column types
+   * Column types.
    */
   type: string[];
 }>;
diff --git a/src/definitions/date.ts b/src/definitions/date.ts
index 2f014f55..b3563582 100644
--- a/src/definitions/date.ts
+++ b/src/definitions/date.ts
@@ -8,6 +8,7 @@ export type DateDefinitions = LocaleEntry<{
    * The translations for months (January - December).
    */
   month: DateEntryDefinition;
+
   /**
    * The translations for weekdays (Sunday - Saturday).
    */
@@ -22,15 +23,18 @@ export interface DateEntryDefinition {
    * The long name of the entry.
    */
   wide: string[];
+
   /**
    * The short name/abbreviation of the entry.
    */
   abbr: string[];
+
   /**
    * The wide name of the entry when used in context. If absent wide will be used instead.
    * It is used to specify a word in context, which may differ from a stand-alone word.
    */
   wide_context?: string[];
+
   /**
    * The short name/abbreviation name of the entry when used in context. If absent abbr will be used instead.
    * It is used to specify a word in context, which may differ from a stand-alone word.
diff --git a/src/definitions/finance.ts b/src/definitions/finance.ts
index d2c26283..47ea6a96 100644
--- a/src/definitions/finance.ts
+++ b/src/definitions/finance.ts
@@ -1,13 +1,14 @@
 import type { LocaleEntry } from './definitions';
 
 /**
- * The possible definitions related to finances.
+ * The possible definitions related to finance.
  */
 export type FinanceDefinitions = LocaleEntry<{
   /**
    * The types of accounts/purposes of an account (e.g. `Savings` account).
    */
   account_type: string[];
+
   /**
    * The pattern by (lowercase) issuer name used to generate credit card codes.
    * `L` will be replaced by the check bit.
@@ -15,10 +16,12 @@ export type FinanceDefinitions = LocaleEntry<{
    * @see Helpers.replaceCreditCardSymbols()
    */
   credit_card: { [issuer: string]: string[] };
+
   /**
    * Currencies by their full name and their symbols (e.g. `US Dollar` -> `USD` / `$`).
    */
   currency: { [currencyName: string]: FinanceCurrencyEntryDefinitions };
+
   /**
    * Types of transactions (e.g. `deposit`).
    */
@@ -33,6 +36,7 @@ export interface FinanceCurrencyEntryDefinitions {
    * The code/short text/abbreviation for the currency (e.g. `USD`).
    */
   code: string;
+
   /**
    * The symbol for the currency (e.g. `$`).
    */
diff --git a/src/definitions/hacker.ts b/src/definitions/hacker.ts
index e6790839..5540a14f 100644
--- a/src/definitions/hacker.ts
+++ b/src/definitions/hacker.ts
@@ -8,26 +8,31 @@ export type HackerDefinitions = LocaleEntry<{
    * Generic computer related abbreviations (e.g. `RAM`, `EXE`).
    */
   abbreviation: string[];
+
   /**
    * Some computer related adjectives or descriptors (e.g. `digital`, `bluetooth`)
    */
   adjective: string[];
+
   /**
    * Some computer related verbs for continuous actions (en: `ing` suffix; e.g. `hacking`).
    */
   ingverb: string[];
+
   /**
-   * Some computer related nouns (e.g. `protocol`, `sensor`)
+   * Some computer related nouns (e.g. `protocol`, `sensor`).
    */
   noun: string[];
+
   /**
    * Some phrases that will be injected with random hacker words.
-   * May use any of the HackerDefinition keys wrapped in double braces.
-   * (e.g. `I'm {{ingverb}} {{adjective}} {{noun}}` )
+   * May use any of the HackerDefinition keys wrapped in double braces
+   * (e.g. `I'm {{ingverb}} {{adjective}} {{noun}}`).
    *
    * @see Helpers.mustache()
    */
   phrase: string[];
+
   /**
    * Some computer related verbs (e.g. `hack`).
    */
diff --git a/src/definitions/internet.ts b/src/definitions/internet.ts
index a7801066..daa62ecc 100644
--- a/src/definitions/internet.ts
+++ b/src/definitions/internet.ts
@@ -9,18 +9,22 @@ export type InternetDefinitions = LocaleEntry<{
    * Common top level and similar domains (e.g `de`, `co.uk`).
    */
   domain_suffix: string[];
+
   /**
    * Some email domains containing `example` (e.g. `example.com`).
    */
   example_email: string[];
+
   /**
    * Some free-mail domains used in that country (e.g. `gmail.de`).
    */
   free_email: string[];
+
   /**
    * List of all fully-qualified emojis.
    */
   emoji: Record<EmojiType, string[]>;
+
   /**
    * List of some HTTP status codes.
    */
diff --git a/src/definitions/name.ts b/src/definitions/name.ts
index 9098a66a..d4999a30 100644
--- a/src/definitions/name.ts
+++ b/src/definitions/name.ts
@@ -26,7 +26,7 @@ export type NameDefinitions = LocaleEntry<{
   suffix: string[];
 
   /**
-   * A list of patterns used to generate names (Fake-Pattern[]).
+   * A list of patterns used to generate names.
    */
   name: string[];
 
diff --git a/src/definitions/science.ts b/src/definitions/science.ts
index dbe35f4f..29e4f59e 100644
--- a/src/definitions/science.ts
+++ b/src/definitions/science.ts
@@ -9,8 +9,9 @@ export type ScienceDefinitions = LocaleEntry<{
    * Some science units.
    */
   unit: readonly Unit[];
+
   /**
-   * Some periodic table element informtion.
+   * Some periodic table element information.
    */
   chemicalElement: readonly ChemicalElement[];
 }>;
diff --git a/src/definitions/system.ts b/src/definitions/system.ts
index c6aa16c7..b344fad4 100644
--- a/src/definitions/system.ts
+++ b/src/definitions/system.ts
@@ -1,13 +1,14 @@
 import type { LocaleEntry } from './definitions';
 
 /**
- * The possible definitions related to files and the system.
+ * The possible definitions related to files and operating systems.
  */
 export type SystemDefinitions = LocaleEntry<{
   /**
    * Returns some common file paths.
    */
   directoryPaths: string[];
+
   /**
    * The mime type definitions with some additional information.
    */
@@ -15,7 +16,7 @@ export type SystemDefinitions = LocaleEntry<{
 }>;
 
 /**
- * The mime type entry details.
+ * The mime-type entry details.
  */
 export interface SystemMimeTypeEntryDefinitions {
   source?: string;
diff --git a/src/definitions/vehicle.ts b/src/definitions/vehicle.ts
index 8904a9eb..369017d0 100644
--- a/src/definitions/vehicle.ts
+++ b/src/definitions/vehicle.ts
@@ -8,18 +8,22 @@ export type VehicleDefinitions = LocaleEntry<{
    * Some types of bicycles.
    */
   bicycle_type: string[];
+
   /**
    * Some types of fuel (e.g. `Gasoline`).
    */
   fuel: string[];
+
   /**
    * Some brands of manufactures (e.g. `Tesla`).
    */
   manufacturer: string[];
+
   /**
    * Some names of models (e.g. `Fiesta`).
    */
   model: string[];
+
   /**
    * Some types of vehicles (e.g. `Minivan`).
    */