Doc Update: Adds Suggestions for #6043 #6044

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.

Sign up for GitHub

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

Jump to bottom

Open

starry48 wants to merge 2 commits into Textualize:main from starry48:docupdate

starry48 commented Aug 13, 2025 •

edited

Loading

Adds Suggestions made in #6043

[Not applied] Docstrings on all new or modified functions / classes
[ ✅] Updated documentation
[Not applied] Updated CHANGELOG.md (where appropriate)

Poetry Installation Link Redirecting to the instructions

Fix made: Changes the link in the first step to take the user to the installation instructions

poetry shell command needs prerequisites installed

Fix made: Changes the poetry shell command to poetry env activate which still creates the virtual environment without more packages being installed

Clarify textual --version requires poetry run

Fix made: Clarified that the textual --version requires poetry run command to be able to see the latest version of textual.

Adding how to Run examples

Fix made: Adding how to Run examples by explaining to use the poetry run python <SCRIPT_NAME.py>

Starry and others added 2 commits

August 13, 2025 09:51


          doc update

30c77d3


          Merge branch 'Textualize:main' into docupdate

7d322ff

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

Labels

None yet