docs: improve nested type docstrings #8358
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
cpcloud
requested changes
Feb 14, 2024
NickCrews
added a commit
to NickCrews/ibis
that referenced
this pull request
Mar 5, 2024
NickCrews
force-pushed
the
nested-docstrings
branch
from
9b76924
to
d7981f9
Compare
NickCrews
added a commit
to NickCrews/ibis
that referenced
this pull request
Mar 5, 2024
gforsyth
pushed a commit
that referenced
this pull request
Mar 6, 2024
NickCrews
force-pushed
the
nested-docstrings
branch
2 times, most recently
from
099cb38
to
53c4470
Compare
|
Taking another look now. Thanks for bearing with me in the slightly longer review cycle 😅 |
- Improve toplevel docstring for types so you can get a sense for what they type even is. - fix explanations of how the datashape is determined in .map(), .array(), and .struct(). - some examples weren't really needed - used "column" not "array" when describing datashape, since "array" has another meaning in ibis
cpcloud
force-pushed
the
nested-docstrings
branch
from
53c4470
to
1628354
Compare
cpcloud
force-pushed
the
nested-docstrings
branch
from
1628354
to
47a5e9f
Compare
ibis-docs-bot
bot
removed
the
docs-preview
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.
The existing descriptions for these types at https://ibis-project.org/reference/expression-collections are pretty bad.
Add "corresponds to" list so peoplecan link this concept to concepts they are familiar to.