Document CellKey being a RowKey, ColumnKey tuple #3624
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
davep
reviewed
Nov 1, 2023
| @@ -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. | |||
There was a problem hiding this comment.
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.
davep
approved these changes
Nov 2, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Please review the following checklist.
Following #3623.
An alternative is to add docstrings to the
row_keyandcolumn_keyattributes of theCellKeyclass. (UPDATE: also added)