Merge pull request #5560 from Textualize/bump2.1.0

bump 2.1.0

Author: willmcgugan

CHANGELOG.md

@@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
-## Unreleased
+## [2.1.0] - 2025-02-19
 
 ### Fixed
 
@@ -16,7 +16,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Fixed flipped title colors in panel border https://github.com/Textualize/textual/issues/5548
 - Fixed detection of smooth scrolling https://github.com/Textualize/textual/pull/5558
 
-
 ### Added
 
 - Added `pointer_x`, `pointer_y`, `pointer_screen_x`, and `pointer_screen_y` attributes to mouse events https://github.com/Textualize/textual/pull/5556
@@ -2762,6 +2761,7 @@ https://textual.textualize.io/blog/2022/11/08/version-040/#version-040
 - New handler system for messages that doesn't require inheritance
 - Improved traceback handling
 
+[2.1.0]: https://github.com/Textualize/textual/compare/v2.0.4...v2.1.0
 [2.0.4]: https://github.com/Textualize/textual/compare/v2.0.3...v2.0.4
 [2.0.3]: https://github.com/Textualize/textual/compare/v2.0.2...v2.0.3
 [2.0.2]: https://github.com/Textualize/textual/compare/v2.0.1...v2.0.2

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "textual"
-version = "2.0.4"
+version = "2.1.0"
 homepage = "https://github.com/Textualize/textual"
 repository = "https://github.com/Textualize/textual"
 documentation = "https://textual.textualize.io/"

src/textual/content.py

@@ -371,11 +371,15 @@ def get_optimal_width(
         rules: RulesMap,
         container_width: int,
     ) -> int:
-        """Get optimal width of the visual to display its content. Part of the Textual Visual protocol.
+        """Get optimal width of the Visual to display its content.
+
+        The exact definition of "optimal width" is dependant on the Visual, but
+        will typically be wide enough to display output without cropping or wrapping,
+        and without superfluous space.
 
         Args:
-            widget: Parent widget.
-            container_size: The size of the container.
+            rules: A mapping of style rules, such as the Widgets `styles` object.
+            container_width: The size of the container in cells.
 
         Returns:
             A width in cells.
@@ -385,11 +389,11 @@ def get_optimal_width(
         return max(line.cell_length for line in lines)
 
     def get_height(self, rules: RulesMap, width: int) -> int:
-        """Get the height of the visual if rendered with the given width. Part of the Textual Visual protocol.
+        """Get the height of the Visual if rendered at the given width.
 
         Args:
-            widget: Parent widget.
-            width: Width of visual.
+            rules: A mapping of style rules, such as the Widgets `styles` object.
+            width: Width of visual in cells.
 
         Returns:
             A height in lines.