txtwrap 3.0.0__tar.gz → 3.1.0__tar.gz

{txtwrap-3.0.0/txtwrap.egg-info → txtwrap-3.1.0}/PKG-INFO

@@ -1,11 +1,13 @@
 Metadata-Version: 2.4
 Name: txtwrap
-Version: 3.0.0
+Version: 3.1.0
 Summary: A tool for wrapping and filling text.
 Home-page: https://github.com/azzammuhyala/txtwrap
 Author: azzammuhyala
 Author-email: azzammuhyala@gmail.com
 License: MIT
+Project-URL: Source, https://github.com/azzammuhyala/txtwrap
+Project-URL: Bug Tracker, https://github.com/azzammuhyala/txtwrap/issues
 Keywords: wrap,wrapper,wrapping,wrapped,text wrap,text wrapper,text wrapping,text wrapped
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
@@ -22,27 +24,29 @@ Dynamic: description-content-type
 Dynamic: home-page
 Dynamic: keywords
 Dynamic: license
+Dynamic: project-url
 Dynamic: requires-python
 Dynamic: summary
 
 # TxTWrap🔡
 A tool for wrapping and filling text.🔨
 
-Package version: **3.0.0** <br>
+Package version: **3.1.0** <br>
 Python requires version: **>=3.0.0** <br>
 Python stub file requires version: **>=3.5.0** <br>
 
 - [`LOREM_IPSUM_WORDS`](#lorem-ipsum)
 - [`LOREM_IPSUM_SENTENCES`](#lorem-ipsum)
 - [`LOREM_IPSUM_PARAGRAPHS`](#lorem-ipsum)
-- [`SEPARATOR_WHITESPACE`](#separators) (➕ New)
-- [`SEPARATOR_ESCAPE`](#separators) (➕ New)
+- [`SEPARATOR_WHITESPACE`](#separators) (✅ Updated)
+- [`SEPARATOR_ESCAPE`](#separators) (✅ Updated)
+- [`SEPARATOR_NEWLINE`](#separators) (➕ New)
+- [`SEPARATOR_NEWLINE_AND_BREAK`](#separators) (➕ New)
 - [`TextWrapper`](#textwrapper) (✅ Updated)
-- [`sanitize`](#sanitizetext) (🛠️ Fixed)
 - [`wrap`](#wraptext-return_detailsfalse) (✅ Updated)
-- [`align`](#aligntext-return_detailsfalse) (🛠️ Fixed)
-- [`fillstr`](#fillstrtext) (🛠️ Fixed)
-- [`shorten`](#shortentext) (🛠️ Fixed)
+- [`align`](#aligntext-return_detailsfalse) (✅ Updated)
+- [`fillstr`](#fillstrtext) (✅ Updated)
+- [`shorten`](#shortentext) (✅ Updated)
 
 # Documents📄
 This module is inspired by the [`textwrap`](https://docs.python.org/3/library/textwrap.html) module, which provides
@@ -55,6 +59,7 @@ filling _monospace fonts_ but also for other font types, such as _Arial_, _Times
 <h1></h1>
 
 ## Constants
+_File: **txtwrap.constants**_
 
 ### Lorem ipsum
 ```py
@@ -73,16 +78,20 @@ A _Lorem Ipsum_ collection of words, sentences, and paragraphs that can be used
 ```py
 SEPARATOR_WHITESPACE
 SEPARATOR_ESCAPE
+SEPARATOR_NEWLINE
+SEPARATOR_NEWLINE_AND_BREAK
 ```
 A collection of separators that can be used to separate text.
-- `SEPARATOR_WHITESPACE` contains whitespace characters.
-- `SEPARATOR_ESCAPE` contains whitespace characters including `'\0'`, `'\a'`, and `'\b'`.
-
-To use this, assign this constant to the [`separator`](#separator) parameter.
+- `SEPARATOR_WHITESPACE` (for [`word_separator`](#word_separator)) regex contains whitespace characters.
+- `SEPARATOR_ESCAPE` (for [`word_separator`](#word_separator)) regex contains whitespace characters including `'\a'`, `'\b'`, and `'\0'`.
+- `SEPARATOR_NEWLINE` (for [`newline_separator`](#newline_separator)) regex contains newline characters.
+- `SEPARATOR_NEWLINE_AND_BREAK` (for [`newline_separator`](#newline_separator)) regex contains newline characters including breaks tag `<br>`.
 
 <h1></h1>
 
 ## `TextWrapper`
+_File: **txtwrap.wrapper**_
+
 ```py
 class TextWrapper:
 
@@ -93,15 +102,17 @@ class TextWrapper:
         mode: Literal['mono', 'word'] = 'word',
         alignment: Literal['left', 'center', 'right', 'fill', 'fill-left', 'fill-center', 'fill-right'] = 'left',
         placeholder: str = '...',
-        fillchar: str = ' ',
-        separator: Optional[Union[str, Iterable[str]]] = None,
+        space_character: str = ' ',
+        newline_character: str = '\n',
+        word_separator: Optional[Union[str, Tuple[str, int]]] = None,
+        newline_separator: Optional[Union[str, Tuple[str, int]]] = None,
         max_lines: Optional[int] = None,
-        preserve_empty_lines: bool = True,
+        empty_lines: bool = True,
         minimum_width: bool = True,
-        drop_separator: bool = False,
+        excess_word_separator: bool = False,
         justify_last_line: bool = False,
         break_on_hyphens: bool = True,
-        sizefunc: Optional[Callable[[str], Union[Tuple[Union[int, float], Union[int, float]], int, float]]] = None
+        size_function: Optional[Callable[[str], Union[Tuple[Union[int, float], Union[int, float]], int, float]]] = None
     ) -> None
 ```
 A class that handles all functions available in this module. Each keyword argument corresponds to its attribute.
@@ -114,9 +125,6 @@ is equivalent to:
 wrapper = TextWrapper()
 wrapper.width = 100
 ```
-You can reuse [`TextWrapper`](#textwrapper) multiple times or modify its options by assigning new values to its
-attributes. However, it is recommended not to reuse [`TextWrapper`](#textwrapper) too frequently inside a specific loop,
-as each attribute has type checking, which may reduce performance.
 
 <h1></h1>
 
@@ -158,16 +166,29 @@ as each attribute has type checking, which may reduce performance.
 
 <h1></h1>
 
-#### **`fillchar`**
-(Default: `' '`) The character used for padding.
+#### **`space_character`**
+(Default: `' '`) The character used for padding and for the word separator character.
+
+<h1></h1>
+
+#### **`newline_character`**
+(Default: `'\n'`) The character used for line separator.
 
 <h1></h1>
 
-#### **`separator`**
+#### **`word_separator`**
 (Default: `None`) The character used to separate words.
 - `None`: Uses whitespace as the separator.
-- `str`: Uses the specified character.
-- `Iterable[str]`: Uses multiple specified characters.
+- `str`: Regex separator in split form.
+- `Tuple[str, int]`: Regex separator in split form with flags.
+
+<h1></h1>
+
+#### **`newline_separator`**
+(Default: `None`) The character used to separate lines.
+- `None`: Uses standard newline as the separator.
+- `str`: Regex separator in split form.
+- `Tuple[str, int]`: Regex separator in split form with flags.
 
 <h1></h1>
 
@@ -179,7 +200,7 @@ as each attribute has type checking, which may reduce performance.
 
 <h1></h1>
 
-#### **`preserve_empty_lines`**
+#### **`empty_lines`**
 (Default: `True`) Retains empty lines in the wrapped text.
 
 <h1></h1>
@@ -190,8 +211,8 @@ enabling this attribute removes unnecessary empty space.
 
 <h1></h1>
 
-#### **`drop_separator`**
-(Default: `False`) Removes the separator between more than one word at a time.
+#### **`excess_word_separator`**
+(Default: `False`) Removes excess separators from between words one at a time.
 
 <h1></h1>
 
@@ -206,7 +227,7 @@ enabling this attribute removes unnecessary empty space.
 
 <h1></h1>
 
-#### **`sizefunc`**
+#### **`size_function`**
 (Default: `None`) A function used to calculate the width and height or only the width of each string.
 
 If the function calculates both width and height, it must return a tuple containing two values:
@@ -233,39 +254,29 @@ is equivalent to:
 <h1></h1>
 
 #### **`copy`**
-Creates and returns a copy of the [`TextWrapper`](#textwrapper) object.
-
-<h1></h1>
-
-#### **`sanitize(text)`**
-Removes excessive characters from [`separator`](#separator) and replaces them with the [`fillchar`](#fillchar)
-character.
-
-For example:
-```py
->>> TextWrapper().sanitize("\tHello \nWorld!\r ")
-'Hello World!'
-```
+Creates and returns a copy of the [`TextWrapper`](#textwrapper) object. (External function using `copy.copy`)
 
 <h1></h1>
 
 #### **`wrap(text, return_details=False)`**
 Returns a list of wrapped text strings. If `return_details=True`, returns a dictionary containing:
 - `'wrapped'`: A list of wrapped text fragments.
-- `'start_lines'`: A set of indices marking the start of line.
-- `'end_lines'`: A set of indices marking the end of line.
+- `'start_lines'`: A list of indices marking the start of line.
+- `'end_lines'`: A list of indices marking the end of line.
 
 For example:
 ```py
->>> TextWrapper(width=15).wrap(LOREM_IPSUM_WORDS)
-['Lorem ipsum', 'odor amet,', 'consectetuer', 'adipiscing', 'elit.']
->>> info = TextWrapper(width=15).wrap(LOREM_IPSUM_WORDS, return_details=True)
->>> info
-{'wrapped': ['Lorem ipsum', 'odor amet,', 'consectetuer', 'adipiscing', 'elit.'], 'start_lines': {1}, 'end_lines': {5}}
->>> info['wrapped'][next(iter(info['start_lines'])) - 1]
-'Lorem ipsum'
->>> info['wrapped'][next(iter(info['end_lines'])) - 1]
-'elit.'
+>>> txtwrap.wrap(txtwrap.LOREM_IPSUM_WORDS, width=20)
+['Lorem ipsum odor', 'amet, consectetuer', 'adipiscing elit.']
+>>> wrapped_info = txtwrap.wrap(txtwrap.LOREM_IPSUM_WORDS, width=20, return_details=True)
+>>> start_lines = wrapped_info['start_lines']
+>>> end_lines = wrapped_info['end_lines']
+>>> wrapped_info
+{'wrapped': ['Lorem ipsum odor', 'amet, consectetuer', 'adipiscing elit.'], 'start_lines': [1], 'end_lines': [3]}
+>>> wrapped_info['wrapped'][start_lines[0] - 1]
+'Lorem ipsum odor'
+>>> wrapped_info['wrapped'][end_lines[0] - 1]
+'adipiscing elit.'
 ```
 
 <h1></h1>
@@ -273,26 +284,28 @@ For example:
 #### **`align(text, return_details=False)`**
 Returns a list of tuples, where each tuple contains `(xPosition, yPosition, text)`, representing the wrapped text along
 with its coordinates.
-> Note: [`sizefunc`](#sizefunc) must return both width and height.
+> Note: [`size_function`](#size_function) must return both width and height.
 
 If `return_details=True`, returns a dictionary containing:
 - `'aligned'`: A list of wrapped text with coordinate data.
 - `'wrapped'`: A list of wrapped text fragments.
-- `'start_lines'`: A set of indices marking the start of line.
-- `'end_lines'`: A set of indices marking the end of line.
+- `'start_lines'`: A list of indices marking the start of line.
+- `'end_lines'`: A list of indices marking the end of line.
 - `'size'`: A calculated text size.
 
 For example:
 ```py
->>> TextWrapper(width=20).align(LOREM_IPSUM_WORDS)
+>>> txtwrap.align(txtwrap.LOREM_IPSUM_WORDS, width=20)
 [(0, 0, 'Lorem ipsum odor'), (0, 1, 'amet, consectetuer'), (0, 2, 'adipiscing elit.')]
->>> info = TextWrapper(width=20).align(LOREM_IPSUM_WORDS, return_details=True)
->>> info
+>>> aligned_info = txtwrap.align(txtwrap.LOREM_IPSUM_WORDS, width=20, return_details=True)
+>>> start_lines = aligned_info['start_lines']
+>>> end_lines = aligned_info['end_lines']
+>>> aligned_info
 {'aligned': [(0, 0, 'Lorem ipsum odor'), (0, 1, 'amet, consectetuer'), (0, 2, 'adipiscing elit.')], 'wrapped': [
-'Lorem ipsum odor', 'amet, consectetuer', 'adipiscing elit.'], 'start_lines': {1}, 'end_lines': {3}, 'size': (18, 3)}
->>> info['wrapped'][next(iter(info['start_lines'])) - 1]
+'Lorem ipsum odor', 'amet, consectetuer', 'adipiscing elit.'], 'start_lines': [1], 'end_lines': [3], 'size': (18, 3)}
+>>> aligned_info['wrapped'][start_lines[0] - 1]
 'Lorem ipsum odor'
->>> info['wrapped'][next(iter(info['end_lines'])) - 1]
+>>> aligned_info['wrapped'][end_lines[0] - 1]
 'adipiscing elit.'
 ```
 
@@ -300,12 +313,12 @@ For example:
 
 #### **`fillstr(text)`**
 Returns a string with wrapped text formatted for monospace fonts.
-> Note: [`width`](#width), [`line_padding`](#line_padding), and the output of [`sizefunc`](#sizefunc)
+> Note: [`width`](#width), [`line_padding`](#line_padding), and the output of [`size_function`](#size_function)
 (size or just length) must return `int`, not `float`!
 
 For example:
 ```py
->>> s = TextWrapper(width=20).fillstr(LOREM_IPSUM_WORDS)
+>>> s = txtwrap.fillstr(txtwrap.LOREM_IPSUM_WORDS, width=20)
 >>> s
 'Lorem ipsum odor  \namet, consectetuer\nadipiscing elit.  '
 >>> print(s)
@@ -322,7 +335,7 @@ if truncated.
 
 For example:
 ```py
->>> TextWrapper(width=20).shorten(LOREM_IPSUM_WORDS)
+>>> txtwrap.shorten(txtwrap.LOREM_IPSUM_WORDS, width=20)
 'Lorem ipsum odor...'
 ```
 
@@ -334,6 +347,7 @@ For example:
 ```py
 from typing import Literal, Optional
 from txtwrap import align, LOREM_IPSUM_PARAGRAPHS
+
 import pygame
 
 def render_wrap(
@@ -349,9 +363,9 @@ def render_wrap(
     alignment: Literal['left', 'center', 'right', 'fill', 'fill-left', 'fill-center', 'fill-right'] = 'left',
     placeholder: str = '...',
     max_lines: Optional[int] = None,
-    preserve_empty_lines: bool = True,
+    empty_lines: bool = True,
     minimum_width: bool = True,
-    drop_separator: bool = False,
+    excess_word_separator: bool = False,
     justify_last_line: bool = False,
     break_on_hyphens: bool = True
 
@@ -365,13 +379,13 @@ def render_wrap(
         alignment=alignment,
         placeholder=placeholder,
         max_lines=max_lines,
-        preserve_empty_lines=preserve_empty_lines,
+        empty_lines=empty_lines,
         minimum_width=minimum_width,
-        drop_separator=drop_separator,
+        excess_word_separator=excess_word_separator,
         justify_last_line=justify_last_line,
         break_on_hyphens=break_on_hyphens,
         return_details=True,
-        sizefunc=font.size
+        size_function=font.size
     )
 
     surface = pygame.Surface(align_info['size'], pygame.SRCALPHA)
@@ -420,5 +434,5 @@ while running:
 ```py
 from txtwrap import shorten, LOREM_IPSUM_SENTENCES
 
-print(shorten(LOREM_IPSUM_SENTENCES, width=50, placeholder='…'))
+print(shorten(LOREM_IPSUM_SENTENCES, width=50, placeholder='\u2026'))
 ```

{txtwrap-3.0.0 → txtwrap-3.1.0}/README.md

@@ -1,21 +1,22 @@
 # TxTWrap🔡
 A tool for wrapping and filling text.🔨
 
-Package version: **3.0.0** <br>
+Package version: **3.1.0** <br>
 Python requires version: **>=3.0.0** <br>
 Python stub file requires version: **>=3.5.0** <br>
 
 - [`LOREM_IPSUM_WORDS`](#lorem-ipsum)
 - [`LOREM_IPSUM_SENTENCES`](#lorem-ipsum)
 - [`LOREM_IPSUM_PARAGRAPHS`](#lorem-ipsum)
-- [`SEPARATOR_WHITESPACE`](#separators) (➕ New)
-- [`SEPARATOR_ESCAPE`](#separators) (➕ New)
+- [`SEPARATOR_WHITESPACE`](#separators) (✅ Updated)
+- [`SEPARATOR_ESCAPE`](#separators) (✅ Updated)
+- [`SEPARATOR_NEWLINE`](#separators) (➕ New)
+- [`SEPARATOR_NEWLINE_AND_BREAK`](#separators) (➕ New)
 - [`TextWrapper`](#textwrapper) (✅ Updated)
-- [`sanitize`](#sanitizetext) (🛠️ Fixed)
 - [`wrap`](#wraptext-return_detailsfalse) (✅ Updated)
-- [`align`](#aligntext-return_detailsfalse) (🛠️ Fixed)
-- [`fillstr`](#fillstrtext) (🛠️ Fixed)
-- [`shorten`](#shortentext) (🛠️ Fixed)
+- [`align`](#aligntext-return_detailsfalse) (✅ Updated)
+- [`fillstr`](#fillstrtext) (✅ Updated)
+- [`shorten`](#shortentext) (✅ Updated)
 
 # Documents📄
 This module is inspired by the [`textwrap`](https://docs.python.org/3/library/textwrap.html) module, which provides
@@ -28,6 +29,7 @@ filling _monospace fonts_ but also for other font types, such as _Arial_, _Times
 <h1></h1>
 
 ## Constants
+_File: **txtwrap.constants**_
 
 ### Lorem ipsum
 ```py
@@ -46,16 +48,20 @@ A _Lorem Ipsum_ collection of words, sentences, and paragraphs that can be used
 ```py
 SEPARATOR_WHITESPACE
 SEPARATOR_ESCAPE
+SEPARATOR_NEWLINE
+SEPARATOR_NEWLINE_AND_BREAK
 ```
 A collection of separators that can be used to separate text.
-- `SEPARATOR_WHITESPACE` contains whitespace characters.
-- `SEPARATOR_ESCAPE` contains whitespace characters including `'\0'`, `'\a'`, and `'\b'`.
-
-To use this, assign this constant to the [`separator`](#separator) parameter.
+- `SEPARATOR_WHITESPACE` (for [`word_separator`](#word_separator)) regex contains whitespace characters.
+- `SEPARATOR_ESCAPE` (for [`word_separator`](#word_separator)) regex contains whitespace characters including `'\a'`, `'\b'`, and `'\0'`.
+- `SEPARATOR_NEWLINE` (for [`newline_separator`](#newline_separator)) regex contains newline characters.
+- `SEPARATOR_NEWLINE_AND_BREAK` (for [`newline_separator`](#newline_separator)) regex contains newline characters including breaks tag `<br>`.
 
 <h1></h1>
 
 ## `TextWrapper`
+_File: **txtwrap.wrapper**_
+
 ```py
 class TextWrapper:
 
@@ -66,15 +72,17 @@ class TextWrapper:
         mode: Literal['mono', 'word'] = 'word',
         alignment: Literal['left', 'center', 'right', 'fill', 'fill-left', 'fill-center', 'fill-right'] = 'left',
         placeholder: str = '...',
-        fillchar: str = ' ',
-        separator: Optional[Union[str, Iterable[str]]] = None,
+        space_character: str = ' ',
+        newline_character: str = '\n',
+        word_separator: Optional[Union[str, Tuple[str, int]]] = None,
+        newline_separator: Optional[Union[str, Tuple[str, int]]] = None,
         max_lines: Optional[int] = None,
-        preserve_empty_lines: bool = True,
+        empty_lines: bool = True,
         minimum_width: bool = True,
-        drop_separator: bool = False,
+        excess_word_separator: bool = False,
         justify_last_line: bool = False,
         break_on_hyphens: bool = True,
-        sizefunc: Optional[Callable[[str], Union[Tuple[Union[int, float], Union[int, float]], int, float]]] = None
+        size_function: Optional[Callable[[str], Union[Tuple[Union[int, float], Union[int, float]], int, float]]] = None
     ) -> None
 ```
 A class that handles all functions available in this module. Each keyword argument corresponds to its attribute.
@@ -87,9 +95,6 @@ is equivalent to:
 wrapper = TextWrapper()
 wrapper.width = 100
 ```
-You can reuse [`TextWrapper`](#textwrapper) multiple times or modify its options by assigning new values to its
-attributes. However, it is recommended not to reuse [`TextWrapper`](#textwrapper) too frequently inside a specific loop,
-as each attribute has type checking, which may reduce performance.
 
 <h1></h1>
 
@@ -131,16 +136,29 @@ as each attribute has type checking, which may reduce performance.
 
 <h1></h1>
 
-#### **`fillchar`**
-(Default: `' '`) The character used for padding.
+#### **`space_character`**
+(Default: `' '`) The character used for padding and for the word separator character.
+
+<h1></h1>
+
+#### **`newline_character`**
+(Default: `'\n'`) The character used for line separator.
 
 <h1></h1>
 
-#### **`separator`**
+#### **`word_separator`**
 (Default: `None`) The character used to separate words.
 - `None`: Uses whitespace as the separator.
-- `str`: Uses the specified character.
-- `Iterable[str]`: Uses multiple specified characters.
+- `str`: Regex separator in split form.
+- `Tuple[str, int]`: Regex separator in split form with flags.
+
+<h1></h1>
+
+#### **`newline_separator`**
+(Default: `None`) The character used to separate lines.
+- `None`: Uses standard newline as the separator.
+- `str`: Regex separator in split form.
+- `Tuple[str, int]`: Regex separator in split form with flags.
 
 <h1></h1>
 
@@ -152,7 +170,7 @@ as each attribute has type checking, which may reduce performance.
 
 <h1></h1>
 
-#### **`preserve_empty_lines`**
+#### **`empty_lines`**
 (Default: `True`) Retains empty lines in the wrapped text.
 
 <h1></h1>
@@ -163,8 +181,8 @@ enabling this attribute removes unnecessary empty space.
 
 <h1></h1>
 
-#### **`drop_separator`**
-(Default: `False`) Removes the separator between more than one word at a time.
+#### **`excess_word_separator`**
+(Default: `False`) Removes excess separators from between words one at a time.
 
 <h1></h1>
 
@@ -179,7 +197,7 @@ enabling this attribute removes unnecessary empty space.
 
 <h1></h1>
 
-#### **`sizefunc`**
+#### **`size_function`**
 (Default: `None`) A function used to calculate the width and height or only the width of each string.
 
 If the function calculates both width and height, it must return a tuple containing two values:
@@ -206,39 +224,29 @@ is equivalent to:
 <h1></h1>
 
 #### **`copy`**
-Creates and returns a copy of the [`TextWrapper`](#textwrapper) object.
-
-<h1></h1>
-
-#### **`sanitize(text)`**
-Removes excessive characters from [`separator`](#separator) and replaces them with the [`fillchar`](#fillchar)
-character.
-
-For example:
-```py
->>> TextWrapper().sanitize("\tHello \nWorld!\r ")
-'Hello World!'
-```
+Creates and returns a copy of the [`TextWrapper`](#textwrapper) object. (External function using `copy.copy`)
 
 <h1></h1>
 
 #### **`wrap(text, return_details=False)`**
 Returns a list of wrapped text strings. If `return_details=True`, returns a dictionary containing:
 - `'wrapped'`: A list of wrapped text fragments.
-- `'start_lines'`: A set of indices marking the start of line.
-- `'end_lines'`: A set of indices marking the end of line.
+- `'start_lines'`: A list of indices marking the start of line.
+- `'end_lines'`: A list of indices marking the end of line.
 
 For example:
 ```py
->>> TextWrapper(width=15).wrap(LOREM_IPSUM_WORDS)
-['Lorem ipsum', 'odor amet,', 'consectetuer', 'adipiscing', 'elit.']
->>> info = TextWrapper(width=15).wrap(LOREM_IPSUM_WORDS, return_details=True)
->>> info
-{'wrapped': ['Lorem ipsum', 'odor amet,', 'consectetuer', 'adipiscing', 'elit.'], 'start_lines': {1}, 'end_lines': {5}}
->>> info['wrapped'][next(iter(info['start_lines'])) - 1]
-'Lorem ipsum'
->>> info['wrapped'][next(iter(info['end_lines'])) - 1]
-'elit.'
+>>> txtwrap.wrap(txtwrap.LOREM_IPSUM_WORDS, width=20)
+['Lorem ipsum odor', 'amet, consectetuer', 'adipiscing elit.']
+>>> wrapped_info = txtwrap.wrap(txtwrap.LOREM_IPSUM_WORDS, width=20, return_details=True)
+>>> start_lines = wrapped_info['start_lines']
+>>> end_lines = wrapped_info['end_lines']
+>>> wrapped_info
+{'wrapped': ['Lorem ipsum odor', 'amet, consectetuer', 'adipiscing elit.'], 'start_lines': [1], 'end_lines': [3]}
+>>> wrapped_info['wrapped'][start_lines[0] - 1]
+'Lorem ipsum odor'
+>>> wrapped_info['wrapped'][end_lines[0] - 1]
+'adipiscing elit.'
 ```
 
 <h1></h1>
@@ -246,26 +254,28 @@ For example:
 #### **`align(text, return_details=False)`**
 Returns a list of tuples, where each tuple contains `(xPosition, yPosition, text)`, representing the wrapped text along
 with its coordinates.
-> Note: [`sizefunc`](#sizefunc) must return both width and height.
+> Note: [`size_function`](#size_function) must return both width and height.
 
 If `return_details=True`, returns a dictionary containing:
 - `'aligned'`: A list of wrapped text with coordinate data.
 - `'wrapped'`: A list of wrapped text fragments.
-- `'start_lines'`: A set of indices marking the start of line.
-- `'end_lines'`: A set of indices marking the end of line.
+- `'start_lines'`: A list of indices marking the start of line.
+- `'end_lines'`: A list of indices marking the end of line.
 - `'size'`: A calculated text size.
 
 For example:
 ```py
->>> TextWrapper(width=20).align(LOREM_IPSUM_WORDS)
+>>> txtwrap.align(txtwrap.LOREM_IPSUM_WORDS, width=20)
 [(0, 0, 'Lorem ipsum odor'), (0, 1, 'amet, consectetuer'), (0, 2, 'adipiscing elit.')]
->>> info = TextWrapper(width=20).align(LOREM_IPSUM_WORDS, return_details=True)
->>> info
+>>> aligned_info = txtwrap.align(txtwrap.LOREM_IPSUM_WORDS, width=20, return_details=True)
+>>> start_lines = aligned_info['start_lines']
+>>> end_lines = aligned_info['end_lines']
+>>> aligned_info
 {'aligned': [(0, 0, 'Lorem ipsum odor'), (0, 1, 'amet, consectetuer'), (0, 2, 'adipiscing elit.')], 'wrapped': [
-'Lorem ipsum odor', 'amet, consectetuer', 'adipiscing elit.'], 'start_lines': {1}, 'end_lines': {3}, 'size': (18, 3)}
->>> info['wrapped'][next(iter(info['start_lines'])) - 1]
+'Lorem ipsum odor', 'amet, consectetuer', 'adipiscing elit.'], 'start_lines': [1], 'end_lines': [3], 'size': (18, 3)}
+>>> aligned_info['wrapped'][start_lines[0] - 1]
 'Lorem ipsum odor'
->>> info['wrapped'][next(iter(info['end_lines'])) - 1]
+>>> aligned_info['wrapped'][end_lines[0] - 1]
 'adipiscing elit.'
 ```
 
@@ -273,12 +283,12 @@ For example:
 
 #### **`fillstr(text)`**
 Returns a string with wrapped text formatted for monospace fonts.
-> Note: [`width`](#width), [`line_padding`](#line_padding), and the output of [`sizefunc`](#sizefunc)
+> Note: [`width`](#width), [`line_padding`](#line_padding), and the output of [`size_function`](#size_function)
 (size or just length) must return `int`, not `float`!
 
 For example:
 ```py
->>> s = TextWrapper(width=20).fillstr(LOREM_IPSUM_WORDS)
+>>> s = txtwrap.fillstr(txtwrap.LOREM_IPSUM_WORDS, width=20)
 >>> s
 'Lorem ipsum odor  \namet, consectetuer\nadipiscing elit.  '
 >>> print(s)
@@ -295,7 +305,7 @@ if truncated.
 
 For example:
 ```py
->>> TextWrapper(width=20).shorten(LOREM_IPSUM_WORDS)
+>>> txtwrap.shorten(txtwrap.LOREM_IPSUM_WORDS, width=20)
 'Lorem ipsum odor...'
 ```
 
@@ -307,6 +317,7 @@ For example:
 ```py
 from typing import Literal, Optional
 from txtwrap import align, LOREM_IPSUM_PARAGRAPHS
+
 import pygame
 
 def render_wrap(
@@ -322,9 +333,9 @@ def render_wrap(
     alignment: Literal['left', 'center', 'right', 'fill', 'fill-left', 'fill-center', 'fill-right'] = 'left',
     placeholder: str = '...',
     max_lines: Optional[int] = None,
-    preserve_empty_lines: bool = True,
+    empty_lines: bool = True,
     minimum_width: bool = True,
-    drop_separator: bool = False,
+    excess_word_separator: bool = False,
     justify_last_line: bool = False,
     break_on_hyphens: bool = True
 
@@ -338,13 +349,13 @@ def render_wrap(
         alignment=alignment,
         placeholder=placeholder,
         max_lines=max_lines,
-        preserve_empty_lines=preserve_empty_lines,
+        empty_lines=empty_lines,
         minimum_width=minimum_width,
-        drop_separator=drop_separator,
+        excess_word_separator=excess_word_separator,
         justify_last_line=justify_last_line,
         break_on_hyphens=break_on_hyphens,
         return_details=True,
-        sizefunc=font.size
+        size_function=font.size
     )
 
     surface = pygame.Surface(align_info['size'], pygame.SRCALPHA)
@@ -393,5 +404,5 @@ while running:
 ```py
 from txtwrap import shorten, LOREM_IPSUM_SENTENCES
 
-print(shorten(LOREM_IPSUM_SENTENCES, width=50, placeholder='…'))
+print(shorten(LOREM_IPSUM_SENTENCES, width=50, placeholder='\u2026'))
 ```