Fix some locale jsdocs (typos, corrections, make @summary unique)

date-fns · Dec 11, 2021 · 20963fe · bartduisters · Dec 11, 2021 · 20963fe
1 parent 803cbdd
commit 20963fe
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 16 deletions.
diff --git a/src/locale/ar-SA/index.js b/src/locale/ar-SA/index.js
@@ -7,7 +7,7 @@ import match from './_lib/match/index'
 /**
  * @type {Locale}
  * @category Locales
- * @summary Arabic locale (Sauid Arabic).
+ * @summary Arabic locale (Saudi Arabic).
  * @language Arabic
  * @iso-639-2 ara
  * @author Dhaifallah Alwadani [@dalwadani]{@link https://github.com/dalwadani}
@@ -21,8 +21,8 @@ var locale = {
   match: match,
   options: {
     weekStartsOn: 0 /* Sunday */,
-    firstWeekContainsDate: 1
-  }
+    firstWeekContainsDate: 1,
+  },
 }
 
 export default locale
diff --git a/src/locale/ar/index.ts b/src/locale/ar/index.ts
@@ -1,14 +1,14 @@
+import type { Locale } from '../types'
 import formatDistance from './_lib/formatDistance/index'
 import formatLong from './_lib/formatLong/index'
 import formatRelative from './_lib/formatRelative/index'
 import localize from './_lib/localize/index'
 import match from './_lib/match/index'
-import type { Locale } from '../types'
 
 /**
  * @type {Locale}
  * @category Locales
- * @summary Arabic locale (Modern Standard Arabic - Al-fussha).
+ * @summary Arabic locale (Modern Standard Arabic - Al-fusha).
  * @language Modern Standard Arabic
  * @iso-639-2 ara
  * @author Abdallah Hassan [@AbdallahAHO]{@link https://github.com/AbdallahAHO}

diff --git a/src/locale/nl-BE/index.js b/src/locale/nl-BE/index.js
@@ -7,8 +7,8 @@ import match from './_lib/match/index'
 /**
  * @type {Locale}
  * @category Locales
- * @summary Dutch locale.
- * @language Dutch
+ * @summary Flemish locale (Belgium).
+ * @language Flemish
  * @iso-639-2 nld
  * @author Jorik Tangelder [@jtangelder]{@link https://github.com/jtangelder}
  * @author Ruben Stolk [@rubenstolk]{@link https://github.com/rubenstolk}
@@ -24,8 +24,8 @@ var locale = {
   match: match,
   options: {
     weekStartsOn: 1 /* Monday */,
-    firstWeekContainsDate: 4
-  }
+    firstWeekContainsDate: 4,
+  },
 }
 
 export default locale
diff --git a/src/locale/zh-CN/index.js b/src/locale/zh-CN/index.js
@@ -7,7 +7,7 @@ import match from './_lib/match/index'
 /**
  * @type {Locale}
  * @category Locales
- * @summary Chinese Simplified locale.
+ * @summary Chinese Simplified locale (Mainland China).
  * @language Chinese Simplified
  * @iso-639-2 zho
  * @author Changyu Geng [@KingMario]{@link https://github.com/KingMario}
@@ -25,8 +25,8 @@ var locale = {
   match: match,
   options: {
     weekStartsOn: 1 /* Monday */,
-    firstWeekContainsDate: 4
-  }
+    firstWeekContainsDate: 4,
+  },
 }
 
 export default locale
diff --git a/src/locale/zh-HK/index.js b/src/locale/zh-HK/index.js
@@ -7,7 +7,7 @@ import match from './_lib/match/index'
 /**
  * @type {Locale}
  * @category Locales
- * @summary Chinese Traditional locale.
+ * @summary Chinese Traditional locale (Hong Kong).
  * @language Chinese Traditional
  * @iso-639-2 zho
  * @author Gary Ip [@gaplo]{@link https://github.com/gaplo}

diff --git a/src/locale/zh-TW/index.js b/src/locale/zh-TW/index.js
@@ -7,7 +7,7 @@ import match from './_lib/match/index'
 /**
  * @type {Locale}
  * @category Locales
- * @summary Chinese Traditional locale.
+ * @summary Chinese Traditional locale (Taiwan).
  * @language Chinese Traditional
  * @iso-639-2 zho
  * @author tonypai [@tpai]{@link https://github.com/tpai}
@@ -23,8 +23,8 @@ var locale = {
   match: match,
   options: {
     weekStartsOn: 1 /* Monday */,
-    firstWeekContainsDate: 4
-  }
+    firstWeekContainsDate: 4,
+  },
 }
 
 export default locale