Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[REQUEST] Doc: improve/create documentation for default styles #3453

Open
sbraz opened this issue Aug 15, 2024 · 2 comments
Open

[REQUEST] Doc: improve/create documentation for default styles #3453

sbraz opened this issue Aug 15, 2024 · 2 comments

Comments

@sbraz
Copy link
Contributor

sbraz commented Aug 15, 2024

Have you checked the issues for a similar suggestions? → Yes

How would you improve Rich?

Hi,
I would like the documentation to mention all values from rich/default_styles.py. I'll explain why below.

What problem does it solve for you?

While I was playing with progress bars, I found out that "[progress.percentage]{task.percentage:>3.0f}%" is the default format for rich.progress.TaskProgressColumn objects. However, I couldn't easily find where progress.percentage was defined. https://rich.readthedocs.io/en/stable/search.html?q=%22progress.percentage%22&check_keywords=yes&area=default didn't output anything useful.

It was only when I grepped the code that I found its definition here:

"progress.percentage": Style(color="magenta"),

Since the various default styles are used in the example code and the documentation, it would be nice to document them.

Copy link

Thank you for your issue. Give us a little time to review it.

PS. You might want to check the FAQ if you haven't done so already.

This is an automated reply, generated by FAQtory

@sbraz
Copy link
Contributor Author

sbraz commented Aug 15, 2024

I just noticed that the doc mentions python -m rich.default_styles:

python -m rich.default_styles

However, adding the list below the command would still make it easier in my opinion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant