Update docs

Author: dmlls

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Diego Miguel Lozano
+Copyright (c) 2022-2025 Diego Miguel Lozano
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -84,14 +84,14 @@ print(string)  # Foo bar
 string = casefy.separatorcase("fooBar", separator="/")
 print(string)  # foo/bar
 
-string = casefy.separatorcase("fooBARbaz", separator="%", keep_together=["bar"])
+string = casefy.separatorcase("fooBARbaz", separator="%", keep_together=["BAR"])
 print(string)  # foo%bar%baz
 
 # snake_case
 string = casefy.snakecase("fooBar")
 print(string)  # foo_bar
 
-string = casefy.snakecase("fooBARbaz", keep_together=["bar"])
+string = casefy.snakecase("fooBARbaz", keep_together=["BAR"])
 print(string)  # foo_bar_baz
 
 string = casefy.snakecase("FOO BAR")

casefy/casefy.py

@@ -46,7 +46,7 @@ def snakecase(string: str, keep_together: List[str] = None) -> str:
         string (:obj:`str`):
             The string to convert to snake_case.
         keep_together (:obj:`List[str]`, `optional`):
-            Substrings to not split (case sensitive), e.g., "HTTP".
+            Substrings not to split (case sensitive), e.g., "HTTP".
 
     Returns:
         :obj:`str`: The snake_cased string.
@@ -138,7 +138,7 @@ def separatorcase(string: str, separator: str, keep_together: List[str] = None)
         separator (:obj:`str`):
             The separator to use.
         keep_together (:obj:`List[str]`, `optional`):
-            Substrings to not split (case sensitive), e.g., "HTTP".
+            Substrings not to split (case sensitive), e.g., "HTTP".
 
     Returns:
         :obj:`str`: The separator cased string.

docs/source/index.rst

@@ -28,6 +28,10 @@ Examples
 
    import casefy
 
+   # Alphanum3ric case (removes non-alphanumeric chars)
+   string = casefy.alphanumcase("foo - 123 ; bar!")
+   print(string)  # foo123bar
+
    # camelCase
    string = casefy.camelcase("foo_bar")
    print(string)  # fooBar
@@ -38,35 +42,61 @@ Examples
    string = casefy.camelcase("FOO BAR")
    print(string)  # fooBar
 
-   # snake_case
-   string = casefy.snakecase("fooBar")
-   print(string)  # foo_bar
-    
-   string = casefy.snakecase("fooBARbaz", keep_together=["bar"])
-   print(string)  # foo_bar_baz
-   
-   string = casefy.snakecase("FOO BAR")
-   print(string)  # foo_bar
+   # Capital Case
+   string = casefy.capitalcase("fooBar")
+   print(string)  # FooBar
 
    # CONST_CASE
    string = casefy.constcase("fooBar")
    print(string)  # FOO_BAR
-   
+
    # kebab-case
    string = casefy.kebabcase("fooBar")
    print(string)  # foo-bar
-   
-   # separator case
-   string = casefy.separatorcase("fooBar", separator="/")
-   print(string)  # foo/bar
 
-   string = casefy.separatorcase("fooBARbaz", separator="%", keep_together=["bar"])
-   print(string)  # foo%bar%baz
+   # lowercase
+   string = casefy.lowercase("fooBar")
+   print(string)  # foobar
+
+   # PascalCase
+   string = casefy.pascalcase("foo_bar")
+   print(string)  # FooBar
+
+   string = casefy.pascalcase("fooBar")
+   print(string)  # FooBar
 
    # Sentence case
    string = casefy.sentencecase("fooBar")
    print(string)  # Foo bar
 
+   # Separator case
+   string = casefy.separatorcase("fooBar", separator="/")
+   print(string)  # foo/bar
+
+   string = casefy.separatorcase("fooBARbaz", separator="%", keep_together=["BAR"])
+   print(string)  # foo%bar%baz
+
+   # snake_case
+   string = casefy.snakecase("fooBar")
+   print(string)  # foo_bar
+
+   string = casefy.snakecase("fooBARbaz", keep_together=["BAR"])
+   print(string)  # foo_bar_baz
+
+   string = casefy.snakecase("FOO BAR")
+   print(string)  # foo_bar
+
+   # Title Case
+   string = casefy.titlecase("fooBarBaz")
+   print(string)  # Foo Bar Baz
+
+   # UPPERCASE
+   string = casefy.uppercase("fooBar")
+   print(string)  # FOOBAR
+
+   # UPPER-KEBAB-CASE
+   string = casefy.upperkebabcase("fooBar")
+   print(string)  # FOO-BAR
 
 Contents
 --------