update docstrings & change log

Author: xulbux

CHANGELOG.md

@@ -23,6 +23,9 @@
 * Added throttling to the `ProgressBar` update methods to impact the actual process' performance as little as possible.
 * Added a new class `Spinner` to the `console` module, which is used to display a spinner animation in the console during an ongoing process.
 
+**BREAKING CHANGES:**
+* Made the value input into the params `bar_format` and `limited_bar_format` of `ProgressBar` be a list/tuple of strings instead of a single string, so the user can define multiple formats for different console widths.
+* Added a new param <code>sep: str = " "</code> to the `ProgressBar` class, which is used to join multiple bar-format strings.
 
 <span id="v1-9-0" />
 

src/xulbux/console.py

@@ -1312,7 +1312,7 @@ def __init__(
         self.limited_bar_format: list[str] | tuple[str, ...]
         """The simplified format strings used when the console width is too small."""
         self.sep: str
-        """The separator string used to join multiple format strings."""
+        """The separator string used to join multiple bar-format strings."""
         self.chars: tuple[str, ...]
         """A tuple of characters ordered from full to empty progress."""
 
@@ -1658,7 +1658,7 @@ def __init__(
         self.spinner_format: list[str] | tuple[str, ...]
         """The format strings used to render the spinner (joined by `sep`)."""
         self.sep: str
-        """The separator string used to join multiple format strings."""
+        """The separator string used to join multiple spinner-format strings."""
         self.frames: tuple[str, ...]
         """A tuple of strings representing the animation frames."""
         self.interval: float