docs and examples

turbaszek · Sep 11, 2020 · b391635 · b391635
1 parent a424faf
commit b391635
Show file tree

Hide file tree

Showing 9 changed files with 20 additions and 10 deletions.
diff --git 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.2] - Unreleased
+## [6.1.2] - 2020-09-11
 
 ### Added
 
@@ -15,6 +15,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - The `#` sign is included in url highlighting
 
+### Fixed
+
+- Fixed force-color switch in rich.syntax and rich.markdown commands
+
 ## [6.1.1] - 2020-09-07
 
 ### Changed

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -21,7 +21,9 @@ Welcome to Rich's documentation!
 
    markup.rst
    tables.rst
-   panel.rst   
+   padding.rst
+   panel.rst 
+   group.rst  
    columns.rst
    progress.rst
    markdown.rst

diff --git a/docs/source/panel.rst b/docs/source/panel.rst
@@ -1,7 +1,7 @@
 Panel
 =====
 
-To draw a border around any content, construct a :class:`~rich.panel.Panel` with any *renderable* as the first positional argument. Here's an example::
+To draw a border around text or other renderable, construct a :class:`~rich.panel.Panel` with the renderable as the first positional argument. Here's an example::
 
     from rich import print
     from rich.panel import Panel

diff --git a/pyproject.toml b/pyproject.toml
@@ -2,7 +2,7 @@
 name = "rich"
 homepage = "https://github.com/willmcgugan/rich"
 documentation = "https://rich.readthedocs.io/en/latest/"
-version = "6.1.1"
+version = "6.1.2"
 description = "Render rich text, tables, progress bars, syntax highlighting, markdown and more to the terminal"
 authors = ["Will McGugan <willmcgugan@gmail.com>"]
 license = "MIT"

diff --git a/rich/_inspect.py b/rich/_inspect.py
@@ -1,9 +1,9 @@
 from __future__ import absolute_import
 
-from inspect import cleandoc, getdoc, getfile, isclass, isfunction, ismodule, signature
-from typing import Any, Iterable, List, Optional, Tuple
+from inspect import cleandoc, getdoc, getfile, isclass, ismodule, signature
+from typing import Any, Iterable, Optional, Tuple
 
-from .console import Console, ConsoleOptions, RenderableType, RenderGroup, RenderResult
+from .console import RenderableType, RenderGroup
 from .highlighter import ReprHighlighter
 from .jupyter import JupyterMixin
 from .panel import Panel
@@ -74,7 +74,7 @@ def _make_title(self, obj: Any) -> Text:
         title_text = self.highlighter(title_str)
         return title_text
 
-    def __rich__(self) -> "RenderableType":
+    def __rich__(self) -> Panel:
         return Panel.fit(
             RenderGroup(*self._render()),
             title=self.title,

diff --git a/rich/console.py b/rich/console.py
@@ -181,6 +181,8 @@ def __rich_console__(
 
 
 def render_group(fit: bool = False) -> Callable:
+    """A decorator that turns an iterable of renderables in to a group."""
+
     def decorator(method):
         """Convert a method that returns an iterable of renderables in to a RenderGroup."""
 

diff --git a/rich/highlighter.py b/rich/highlighter.py
@@ -78,9 +78,9 @@ class ReprHighlighter(RegexHighlighter):
         r"(?P<number>(?<!\w)\-?[0-9]+\.?[0-9]*(e[\-\+]?\d+?)?\b)",
         r"(?P<number>0x[0-9a-f]*)",
         r"(?P<path>\B(\/[\w\.\-\_\+]+)*\/)(?P<filename>[\w\.\-\_\+]*)?",
-        r"(?<!\\)(?P<str>b?\'\'\'.*?(?<!\\)\'\'\'|b?\'.*?(?<!\\)\'|b?\"\"\".*?(?<!\\)\"\"\"|b?\".*?(?<!\\)\")",
-        r"(?P<ipv4>[0-9]{1,3}.[0-9]{1,3}.[0-9]{1,3}.[0-9]{1,3})",
+        r"(?P<ipv4>[0-9]{1,3}\.[0-9]{1,3}\.[0-gt9]{1,3}\.[0-9]{1,3})",
         r"(?P<ipv6>([A-Fa-f0-9]{1,4}::?){1,7}[A-Fa-f0-9]{1,4})",
+        r"(?<!\\)(?P<str>b?\'\'\'.*?(?<!\\)\'\'\'|b?\'.*?(?<!\\)\'|b?\"\"\".*?(?<!\\)\"\"\"|b?\".*?(?<!\\)\")",
         r"(?P<url>https?:\/\/[0-9a-zA-Z\$\-\_\+\!`\(\)\,\.\?\/\;\:\&\=\%\#]*)",
         r"(?P<uuid>[a-fA-F0-9]{8}\-[a-fA-F0-9]{4}\-[a-fA-F0-9]{4}\-[a-fA-F0-9]{4}\-[a-fA-F0-9]{12})",
     ]

diff --git a/rich/markdown.py b/rich/markdown.py
@@ -511,6 +511,7 @@ def __rich_console__(
         "--force-color",
         dest="force_color",
         action="store_true",
+        default=None,
         help="force color for non-terminals",
     )
     parser.add_argument(

diff --git a/rich/syntax.py b/rich/syntax.py
@@ -326,6 +326,7 @@ def __rich_console__(
         "--force-color",
         dest="force_color",
         action="store_true",
+        default=None,
         help="force color for non-terminals",
     )
     parser.add_argument(