mirror of https://github.com/Textualize/rich.git
docs
This commit is contained in:
parent
c3ee3b05d6
commit
f1826276af
|
@ -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
|
||||
|
||||
|
|
|
@ -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)
|
|
@ -0,0 +1,7 @@
|
|||
rich
|
||||
====
|
||||
|
||||
.. automodule:: rich
|
||||
:members:
|
||||
|
||||
|
|
@ -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.
|
||||
|
|
Loading…
Reference in New Issue