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

Documentation is not up-to-date #4665

Closed
hyhcrh opened this issue Jun 19, 2024 · 3 comments
Closed

Documentation is not up-to-date #4665

hyhcrh opened this issue Jun 19, 2024 · 3 comments

Comments

@hyhcrh
Copy link

hyhcrh commented Jun 19, 2024

As the title depicts. For example, documentation says this:
An alternative to a refresh is recompose. If you set recompose=True on a reactive, then Textual will remove all the child widgets and call compose() again, when the reactive attribute changes.
But I couldn't find this attribute, and when I typed it, the IDE reported accidental arguments.
Then I went into the source code and found that it was renamed to repaint.

Here is another example and I currently can't solve it:
Documentation says this in this link:

ctrl_to_caret = reactive(True)

Convert 'ctrl+' prefix to '^'.
将“ctrl+”前缀转换为“^”。

But I couldn't find similar arguments in the source code. What is it? Or it is removed?

Have you checked closed issues? https://github.com/Textualize/textual/issues?q=is%3Aissue+is%3Aclosed
Yes

It will be helpful if you run the following command and paste the results:

textual diagnose

Textual Diagnostics

Versions

Name Value
Textual 0.46.0
Rich 13.6.0

Python

Name Value
Version 3.10.10
Implementation CPython
Compiler MSC v.1929 64 bit (AMD64)
Executable D:\testTUI\venv\Scripts\python.exe

Operating System

Name Value
System Windows
Release 10
Version 10.0.19041

Terminal

Name Value
Terminal Application Windows Terminal
TERM Not set
COLORTERM Not set
FORCE_COLOR Not set
NO_COLOR Not set

Rich Console options

Name Value
size width=120, height=30
legacy_windows False
min_width 1
max_width 120
is_terminal True
encoding utf-8
max_height 30
justify None
overflow None
no_wrap False
highlight None
markup None
height None
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

@willmcgugan
Copy link
Collaborator

The documentation is up-to-date, but you are using a very old version of Textual. Please update.

Copy link

Don't forget to star the repository!

Follow @textualizeio for Textual updates.

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

No branches or pull requests

2 participants