Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into fix-spinner-style-type
- Loading branch information
Showing
79 changed files
with
1,720 additions
and
1,326 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
|
|
||
| # Frequently Asked Questions | ||
|
|
||
| {%- for question in questions %} | ||
| - [{{ question.title }}](#{{ question.slug }}) | ||
| {%- endfor %} | ||
|
|
||
|
|
||
| {%- for question in questions %} | ||
|
|
||
| <a name="{{ question.slug }}"></a> | ||
| ## {{ question.title }} | ||
|
|
||
| {{ question.body }} | ||
|
|
||
| {%- endfor %} | ||
|
|
||
| <hr> | ||
|
|
||
| Generated by [FAQtory](https://github.com/willmcgugan/faqtory) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| {%- if questions -%} | ||
| {% if questions|length == 1 %} | ||
| We found the following entry in the [FAQ]({{ faq_url }}) which you may find helpful: | ||
| {%- else %} | ||
| We found the following entries in the [FAQ]({{ faq_url }}) which you may find helpful: | ||
| {%- endif %} | ||
|
|
||
| {% for question in questions %} | ||
| - [{{ question.title }}]({{ faq_url }}#{{ question.slug }}) | ||
| {%- endfor %} | ||
|
|
||
| Feel free to close this issue if you found an answer in the FAQ. Otherwise, please give us a little time to review. | ||
|
|
||
| {%- else -%} | ||
| Thank you for your issue. Give us a little time to review it. | ||
|
|
||
| PS. You might want to check the [FAQ]({{ faq_url }}) if you haven't done so already. | ||
| {%- endif %} | ||
|
|
||
| This is an automated reply, generated by [FAQtory](https://github.com/willmcgugan/faqtory) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| name: issues | ||
| on: | ||
| issues: | ||
| types: [opened] | ||
| jobs: | ||
| add-comment: | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| issues: write | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| with: | ||
| ref: master | ||
| - name: Install FAQtory | ||
| run: pip install FAQtory | ||
| - name: Run Suggest | ||
| run: faqtory suggest "${{ github.event.issue.title }}" > suggest.md | ||
| - name: Read suggest.md | ||
| id: suggest | ||
| uses: juliangruber/read-file-action@v1 | ||
| with: | ||
| path: ./suggest.md | ||
| - name: Suggest FAQ | ||
| uses: peter-evans/create-or-update-comment@a35cf36e5301d70b76f316e867e7788a55a31dae | ||
| with: | ||
| issue-number: ${{ github.event.issue.number }} | ||
| body: ${{ steps.suggest.outputs.content }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
|
|
||
| # Frequently Asked Questions | ||
| - [Why does emoji break alignment in a Table or Panel?](#why-does-emoji-break-alignment-in-a-table-or-panel) | ||
| - [Why does content in square brackets disappear?](#why-does-content-in-square-brackets-disappear) | ||
| - [python -m rich.spinner shows extra lines](#python--m-rich.spinner-shows-extra-lines) | ||
| - [How do I log a renderable?](#how-do-i-log-a-renderable) | ||
| - [Strange colors in console output.](#strange-colors-in-console-output.) | ||
|
|
||
| <a name="why-does-emoji-break-alignment-in-a-table-or-panel"></a> | ||
| ## Why does emoji break alignment in a Table or Panel? | ||
|
|
||
| Certain emoji take up double space within the terminal. Unfortunately, terminals don't always agree how wide a given character should be. | ||
|
|
||
| Rich has no way of knowing how wide a character will be on any given terminal. This can break alignment in containers like Table and Panel, where Rich needs to know the width of the content. | ||
|
|
||
| There are also *multiple codepoints* characters, such as country flags, and emoji modifiers, which produce wildly different results across terminal emulators. | ||
|
|
||
| Fortunately, most characters will work just fine. But you may have to avoid using the emojis that break alignment. You will get good results if you stick to emoji released on or before version 9 of the Unicode database, | ||
|
|
||
| <a name="why-does-content-in-square-brackets-disappear"></a> | ||
| ## Why does content in square brackets disappear? | ||
|
|
||
| Rich will treat text within square brackets as *markup tags*, for instance `"[bold]This is bold[/bold]"`. | ||
|
|
||
| If you are printing strings with literally square brackets you can either disable markup, or escape your strings. | ||
| See the docs on [console markup](https://rich.readthedocs.io/en/latest/markup.html) for how to do this. | ||
|
|
||
| <a name="python--m-rich.spinner-shows-extra-lines"></a> | ||
| ## python -m rich.spinner shows extra lines | ||
|
|
||
| The spinner example is know to break on some terminals (Windows in particular). | ||
|
|
||
| Some terminals don't display emoji with the correct width, which means Rich can't always align them accurately inside a panel. | ||
|
|
||
| <a name="how-do-i-log-a-renderable"></a> | ||
| ## How do I log a renderable? | ||
|
|
||
| Python's logging module is designed to work with strings. Consequently you won't be able to log Rich renderables (Table, Tree, etc) by calling `logger.debug` or other similar method. | ||
|
|
||
| You could use the [capture](https://rich.readthedocs.io/en/latest/console.html#capturing-output) API to convert the renderable to a string and log that. However I would advise against it. | ||
|
|
||
| Logging supports configurable back-ends, which means that a log message could go somewhere other than the terminal -- which may not correctly render the formatting and style produced by Rich. | ||
|
|
||
| If you are only logging with a file-handler to stdout, then you probably don't need to use the logging module at all. Consider using [Console.log](https://rich.readthedocs.io/en/latest/reference/console.html#rich.console.Console.log) which will render anything that you can print with Rich, with a timestamp. | ||
|
|
||
| <a name="strange-colors-in-console-output."></a> | ||
| ## Strange colors in console output. | ||
|
|
||
| Rich will highlight certain patterns in your output such as numbers, strings, and other objects like IP addresses. | ||
|
|
||
| Occasionally this may also highlight parts of your output you didn't intend. See the [docs on highlighting](https://rich.readthedocs.io/en/latest/highlighting.html) for how to disable highlighting. | ||
|
|
||
| <hr> | ||
|
|
||
| Generated by [FAQtory](https://github.com/willmcgugan/faqtory) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.