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.

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

Document CellKey being a RowKey, ColumnKey tuple #3624

Merged
merged 2 commits into from
Nov 2, 2023
Merged

Document CellKey being a RowKey, ColumnKey tuple #3624

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
544058a
Document CellKey being a RowKey, ColumnKey tuple
pawamoy Nov 1, 2023
fcd664e
fixup! Document CellKey being a RowKey, ColumnKey tuple
pawamoy Nov 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/textual/widgets/_data_table.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,8 @@ class ColumnKey(StringKey):
class CellKey(NamedTuple):
"""A unique identifier for a cell in the DataTable.

A cell key is a `(row_key, column_key)` tuple.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As per your main comment, I think if it were me I'd be tempted to do both: make a note to this effect here, but also add docstrings to the two properties as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done, WDYT?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's perfect. :-)


Even if the cell changes
visual location (i.e. moves to a different coordinate in the table), this key
can still be used to retrieve it, regardless of where it currently is."""
Expand Down
Loading