feat: Update docstrings in string functions

This commit updates the docstrings in the string functions
(capitalize, lowercase, split, uncapitalize, uppercase) to include
import statements and usage examples directly in the docstrings.
This change makes it easier for users to understand how to use
these functions directly from the source code.

Author: ryoppippi

src/capitalize.ts

@@ -4,18 +4,16 @@ type CapitalizedString<T extends Readonly<string>> = IsStringLiteral<T> extends
   true ? Capitalize<T> : string;
 
 /**
- * @description capitalize first letter of string
+ * capitalize first letter of string
  *
- * @param input - input string to capitalize. type should be matched to T
- *
- * @example
- * capitalize('a') // returns 'A'
+ * ```ts
+ * import { capitalize } from '@ryoppippi/str-fns'
+ * const _: 'A' = capitalize('a');
+ * const __: 'Abc' = capitalize('abc');
+ * const ___: '' = capitalize('');
+ * ```
  *
- * @example
- * capitalize('abc') // returns 'Abc'
- *
- * @example
- * capitalize('') // returns ''
+ * @param input - input string to capitalize. type should be matched to T
  */
 export function capitalize<T extends Readonly<string>>(
   input: T,

src/lowercase.ts

@@ -4,18 +4,15 @@ type LowercaseString<T extends Readonly<string>> = IsStringLiteral<T> extends
   true ? Lowercase<T> : string;
 
 /**
- * @description get lowercase string
+ * get lowercase string
  *
+ * ```ts
+ * import { lowercase } from '@ryoppippi/str-fns'
+ * const _: 'a' = lowercase('A');
+ * const __: 'abc' = lowercase('aBC');
+ * const ___: '' = lowercase('');
+ * ```
  * @param input - input string to capitalize. type should be matched to T
- *
- * @example
- * lowercase('A') // 'a'
- *
- * @example
- * lowercase('aBC') // 'abc'
- *
- * @example
- * lowercase('') // ''
  */
 export function lowercase<T extends Readonly<string>>(
   input: T,

src/split.ts

@@ -7,23 +7,19 @@ type SplitString<
   : Readonly<string[]>;
 
 /**
- * @description Split string by separator
+ *  Split string by separator
+ *
+ * ```ts
+ * import { split } from '@ryoppippi/str-fns'
+ * const _: readonly ['A', 'c'] = split('Abc', 'b');
+ * const __: readonly ['a', 'b', 'c'] = split('a-b-c', '-');
+ * const ___: readonly ['a', '-', 'b', '-', 'c'] = split('a-b-c', '');
+ * const ____: readonly ['a-b-c'] = split('a-b-c', '$');
+ * ```
  *
  * @param input - string to split. type should be matched to T
  *
  * @param separator - separator to split string. type should be matched to U
- *
- * @example
- * split('Abc', 'b') // returns ['A', 'c']
- *
- * @example
- * split('a-b-c', '-') // returns ['a', 'b', 'c']
- *
- * @example
- * split('a-b-c', '') // returns ['a', '-', 'b', '-', 'c']
- *
- * @example
- * split('a-b-c', '$') // returns ['a-b-c']
  */
 export function split<T extends Readonly<string>, U extends Readonly<string>>(
   input: T,

src/uncapitalize.ts

@@ -4,18 +4,16 @@ type UncapitalizedString<T extends Readonly<string>> =
   IsStringLiteral<T> extends true ? Uncapitalize<T> : string;
 
 /**
- * @description uncapitalize first letter of string
+ *  uncapitalize first letter of string
  *
- * @param input - input string to capitalize. type should be matched to T
- *
- * @example
- * uncapitalize('A') // returns 'a'
+ * ```ts
+ * import { uncapitalize } from '@ryoppippi/str-fns'
+ * const _: 'a' = uncapitalize('A');
+ * const __: 'abc' = uncapitalize('Abc');
+ * const ___: '' = uncapitalize('');
+ * ```
  *
- * @example
- * uncapitalize('Abc') // returns 'abc'
- *
- * @example
- * uncapitalize('') // returns ''
+ * @param input - input string to capitalize. type should be matched to T
  */
 export function uncapitalize<T extends Readonly<string>>(
   input: T,

src/uppercase.ts

@@ -6,16 +6,14 @@ type UppercaseString<T extends Readonly<string>> = IsStringLiteral<T> extends
 /**
  * @description get uppercase string
  *
- * @param input - input string to capitalize. type should be matched to T
- *
- * @example
- * uppercase('a') // 'A'
+ * ```ts
+ * import { uppercase } from '@ryoppippi/str-fns'
+ * const _: 'A' = uppercase('a');
+ * const __: 'ABC' = uppercase('abc');
+ * const ___: '' = uppercase('');
+ * ```
  *
- * @example
- * uppercase('abc') // 'Abc'
- *
- * @example
- * uppercase('') // ''
+ * @param input - input string to capitalize. type should be matched to T
  */
 export function uppercase<T extends Readonly<string>>(
   input: T,