diff --git a/CHANGELOG.md b/CHANGELOG.md index 3a6c27b0..a4f1c505 100644 --- a/CHANGELOG.md +++ b/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](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## [6.1.0] - Unreleased +## [6.1.0] - 2020-09-07 ### Added diff --git a/docs/source/introduction.rst b/docs/source/introduction.rst index 3d47f78f..811937ff 100644 --- a/docs/source/introduction.rst +++ b/docs/source/introduction.rst @@ -84,3 +84,14 @@ You can also use this feature to try out Rich *renderables*. Here's an example:: >>> Panel.fit("[bold yellow]Hi, I'm a Panel", border_style="red") Read on to learn more about Rich renderables. + + +Rich Inspector +-------------- + +Rich has an :meth:`~rich.inspect` function which can generate a report on any Python object. It is a fantastic debug aid, and a good example of the output that Rich can generate. Here is a simple example:: + + >>> from rich import inspect + >>> from rich.color import Color + >>> color = Color.parse("red") + >>> inspect(color, methods=True) \ No newline at end of file diff --git a/docs/source/reference/init.rst b/docs/source/reference/init.rst new file mode 100644 index 00000000..3ac3fda2 --- /dev/null +++ b/docs/source/reference/init.rst @@ -0,0 +1,7 @@ +rich +==== + +.. automodule:: rich + :members: + + diff --git a/rich/color.py b/rich/color.py index 103eba77..3a10c5b9 100644 --- a/rich/color.py +++ b/rich/color.py @@ -289,7 +289,7 @@ class Color(NamedTuple): def get_truecolor( self, theme: "TerminalTheme" = None, foreground=True ) -> ColorTriplet: - """Get am equivalent color triplet for this color. + """Get an equivalent color triplet for this color. Args: theme (TerminalTheme, optional): Optional terminal theme, or None to use default. Defaults to None.