Replies: 7 comments
-
We found the following entry in the FAQ which you may find helpful: Feel free to close this issue if you found an answer in the FAQ. Otherwise, please give us a little time to review. This is an automated reply, generated by FAQtory |
Beta Was this translation helpful? Give feedback.
-
Seriously, has anyone ever closed an issue from FAQtory? Ever? |
Beta Was this translation helpful? Give feedback.
-
Yeah, a few times actually. |
Beta Was this translation helpful? Give feedback.
-
Documentation PRs are welcome. |
Beta Was this translation helpful? Give feedback.
-
Still need to add it to the relevant files. I'm traveling, so my side projects are going slow. :) Here's the verbiage for a set of them. Any comments are appreciated as it is faster to incorporate comments in the draft than in the source files and final markdown formatting. Also, I will break it into appropriately sized PRs.
https://textual.textualize.io/guide/ (after) Most of the code in this guide is fully working—you could cut and paste it if you wanted to. (add) The tree of directories under docs/examples contains of hundreds of examples for all parts of Textual. There are also complete applications in Textual's examples/ directory. https://textual.textualize.io/getting_started/ (after) With the repository cloned, navigate to the /examples/ directory where you will find a number of Python files you can run from the command line:
Also, the tree of directories under docs/examples contains of hundreds of examples for all parts of Textual https://textual.textualize.io/widget_gallery/ (After) Welcome to the Textual widget gallery. (add) Most of the code demonstrating each widget is fully working—you could cut and paste it if you wanted to. |
Beta Was this translation helpful? Give feedback.
-
2. Fix minor typos as I run across them again. The most common issue is mixing British American Spellings ("Labelled", "Colour") and American English Spellings ("Labeled", "Color"). Unfortunately, some of these have worked their way into various tests and sample code:
I could open a bug and PR to fix these, though it seems like a small nit. It might be worthwhile to mention somewhere prefering American over British spellings (as LabeledBox is already in the public API). |
Beta Was this translation helpful? Give feedback.
-
Item changes:
_Created pull request #4673 Just handling Widgets, Getting Started, and Guide _
Morphed into trying to fix British spellings and is extremely low priority 12. Create better documentation and example of DomNode.tree(), with an example. (new) |
Beta Was this translation helpful? Give feedback.
-
I have only used Textual for a about a week, and would like to make a few documentation additions:
move_row(1)
gives a starting cursor and that row numbers start at 1.show_cursor(False)
) for a simple reactive display..datatable--even-row
style.ccs_tree()
function and better documentation.My thought is to just write up what I can, each section as a separate commit in a PR, and submit. Any thoughts?
Item 1 was in PR #4673 but was rejected. Will consider additional wording and incorporate into a better paragraph.
Items 5, 6, 7, 8, 9, and 10 were merged in PR #4706.
Beta Was this translation helpful? Give feedback.
All reactions