🔧 fix: try to fix ERR_MASONMARK_NOT_WRITE_ENOUGH_DOCS

axhxrx · Dec 14, 2024 · b97c4a2 · b97c4a2
1 parent dded692
commit b97c4a2
Show file tree

Hide file tree

Showing 7 changed files with 21 additions and 35 deletions.
diff --git a/AlphabeticOrUnderscoreOrHyphenString.ts b/AlphabeticOrUnderscoreOrHyphenString.ts
@@ -15,5 +15,9 @@ const JSRCompatibleFactory = ValidatedString.create(
 const type: ValidatedString<typeof isAlphabeticOrUnderscoreOrHyphen> = JSRCompatibleFactory.type;
 const factory: ValidatedStringFactory<typeof isAlphabeticOrUnderscoreOrHyphen> = JSRCompatibleFactory.factory;
 
+
+/**
+ A string that contains only characters `[a-zA-Z_-]` (letters, underscores, or hyphens).
+ */
 export type AlphabeticOrUnderscoreOrHyphenString = typeof type;
 export const AlphabeticOrUnderscoreOrHyphenString = factory;
diff --git a/AlphabeticOrUnderscoreString.ts b/AlphabeticOrUnderscoreString.ts
@@ -13,5 +13,8 @@ const JSRCompatibleFactory = ValidatedString.create(isAlphabeticOrUnderscore, {
 const type: ValidatedString<typeof isAlphabeticOrUnderscore> = JSRCompatibleFactory.type;
 const factory: ValidatedStringFactory<typeof isAlphabeticOrUnderscore> = JSRCompatibleFactory.factory;
 
+/**
+ A string that contains only characters `[a-zA-Z_]` (letters or underscores).
+ */
 export type AlphabeticOrUnderscoreString = typeof type;
 export const AlphabeticOrUnderscoreString = factory;
diff --git a/AlphabeticString.ts b/AlphabeticString.ts
@@ -13,5 +13,9 @@ const JSRCompatibleFactory = ValidatedString.create(isAlphabetic, {
 const type: ValidatedString<typeof isAlphabetic> = JSRCompatibleFactory.type;
 const factory: ValidatedStringFactory<typeof isAlphabetic> = JSRCompatibleFactory.factory;
 
+
+/**
+ A string that contains only letters `[a-zA-Z]`.
+ */
 export type AlphabeticString = typeof type;
 export const AlphabeticString = factory;
diff --git a/AwesomeString.ts b/AwesomeString.ts
diff --git a/LowercaseAlphabeticString.ts b/LowercaseAlphabeticString.ts
@@ -13,5 +13,8 @@ const JSRCompatibleFactory = ValidatedString.create(isLowercaseAlpha, {
 const type: ValidatedString<typeof isLowercaseAlpha> = JSRCompatibleFactory.type;
 const factory: ValidatedStringFactory<typeof isLowercaseAlpha> = JSRCompatibleFactory.factory;
 
+/**
+ A string that contains only lowercase letters `[a-z]`.
+ */
 export type LowercaseAlphabeticString = typeof type;
 export const LowercaseAlphabeticString = factory;
diff --git a/PrometheusMetricName.ts b/PrometheusMetricName.ts
@@ -15,6 +15,8 @@ const factory: ValidatedStringFactory<typeof isPrometheusMetricName> = JSRCompat
 
 /**
  A validated string that represents a Prometheus metric name. See {@link ValidatedString} for more information. Note that this might not really exactly match the rules for Prometheus metric names, but it's close enough for our purposes; namely, generating metrics — don't rely on this to *validate* Prometheus metric names, as it is based on a quick skim of the Prometheus docs.
+
+ @category Prometheus
  */
 export type PrometheusMetricName = typeof type;
 export const PrometheusMetricName = factory;
diff --git a/PrometheusMetricNameWithoutColon.ts b/PrometheusMetricNameWithoutColon.ts
@@ -17,5 +17,10 @@ const JSRCompatibleFactory = ValidatedString.create(
 const type: ValidatedString<typeof isPrometheusMetricNameWithoutColon> = JSRCompatibleFactory.type;
 const factory: ValidatedStringFactory<typeof isPrometheusMetricNameWithoutColon> = JSRCompatibleFactory.factory;
 
+/**
+ A validated string that represents a Prometheus metric name, but without the colon. See {@link ValidatedString} and {@link PrometheusMetricName} for more information.
+
+ @category Prometheus
+ */
 export type PrometheusMetricNameWithoutColon = typeof type;
 export const PrometheusMetricNameWithoutColon = factory;