docs(python): Fix various typos, grammar and formatting in docstrings and user guide #13506
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
added 2 commits
January 7, 2024 20:45
henryharbeck
requested review from
ritchie46,
stinodego,
c-peters,
alexander-beedie and
MarcoGorelli
as code owners
github-actions
bot
added
documentation
henryharbeck
commented
Jan 7, 2024
henryharbeck
commented
Jan 7, 2024
| @@ -140,7 +140,7 @@ class LazyFrame: | |||
| Two-dimensional data in various forms; dict input must contain Sequences, | |||
| Generators, or a `range`. Sequence may contain Series or other Sequences. | |||
| schema : Sequence of str, (str,DataType) pairs, or a {str:DataType,} dict | |||
| The DataFrame schema may be declared in several ways: | |||
| The LazyFrame schema may be declared in several ways: | |||
There was a problem hiding this comment.
Techincally, you are declaring a DataFrame schema when initialising a LazyFrame through this class, however I think this update reduces potential confusion to the reader.
|
This is a great collection of fixes - well spotted!✌️ |
alexander-beedie
approved these changes
Jan 7, 2024
henryharbeck
changed the title
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.
Changes include
top_k/bottom_kLazyFramebeing aDataFrameand vice-versaI did notice a few more references to a
LazyFramebeing aDataFrameand vice-versa (for example inLazyFrame.join), but will leave for another PR to keep the size manageable.