Skip to content

DOCS: Add example to Align docstring#3879

Merged
willmcgugan merged 2 commits intoTextualize:masterfrom
AttackThwarter:rich-align-edit-1
Jan 23, 2026
Merged

DOCS: Add example to Align docstring#3879
willmcgugan merged 2 commits intoTextualize:masterfrom
AttackThwarter:rich-align-edit-1

Conversation

@AttackThwarter
Copy link
Copy Markdown
Contributor

@AttackThwarter AttackThwarter commented Nov 4, 2025

Type of changes

  • Bug fix
  • New feature
  • Documentation / docstrings
  • Tests
  • Other

Checklist

  • I've run the latest black with default args on new code.
  • I've updated CHANGELOG.md and CONTRIBUTORS.md where appropriate (see note about typos above).
  • I've added tests for new code.
  • I accept that @willmcgugan may be pedantic in the code review.

Description

Hi,

I'm adding a visual, multi-line example to the Align class docstring, as it previously had none.

Since a good example for Align requires imports and setup (like creating a Console and a Panel), I used the .. code-block:: python format for maximum clarity and user-friendliness.

I've also updated CHANGELOG.md and CONTRIBUTORS.md as requested by the contribution guidelines.

@willmcgugan willmcgugan merged commit 1c159fe into Textualize:master Jan 23, 2026
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

Successfully merging this pull request may close these issues.

2 participants