Skip to content

Commit

Permalink
MINOR: [Docs][Python] Fix a few minor typos (#44756)
Browse files Browse the repository at this point in the history
### Rationale for this change

I noticed a few typos in the documentation and a single typo in the pyproject file. This change corrects these typos. 

### What changes are included in this PR?

The following spelling corrections have been applied:

fo -> to
scenerios -> scenarios
wich -> which
suiteable -> suitable
avaiable -> available (this is in the pyproject.toml file regarding a NumPy comment for older Python versions)

### Are these changes tested?

No executable code is modified with these changes.

### Are there any user-facing changes?

Only the documentation is being updated.

Authored-by: Tyler White <[email protected]>
Signed-off-by: Sutou Kouhei <[email protected]>
  • Loading branch information
IndexSeek authored Nov 17, 2024
1 parent 23328ff commit 64a3768
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion python/pyarrow/_fs.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -939,7 +939,7 @@ cdef class FileSystem(_Weakrefable):
... f.write(b'+newly added')
12
Print out the content fo the file:
Print out the content to the file:
>>> with local.open_input_file(path) as f:
... print(f.readall())
Expand Down
2 changes: 1 addition & 1 deletion python/pyarrow/_s3fs.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ cdef class S3FileSystem(FileSystem):
rather than issue two dependent I/O calls.
If true, when creating a directory the code will only create the directory when necessary
at the cost of extra I/O calls. This can be used for key/value cloud storage which has
a hard rate limit to number of object mutation operations or scenerios such as
a hard rate limit to number of object mutation operations or scenarios such as
the directories already exist and you do not have creation access.
retry_strategy : S3RetryStrategy, default AwsStandardS3RetryStrategy(max_attempts=3)
The retry strategy to use with S3; fail after max_attempts. Available
Expand Down
6 changes: 3 additions & 3 deletions python/pyarrow/io.pxi
Original file line number Diff line number Diff line change
Expand Up @@ -1761,7 +1761,7 @@ cdef class CompressedInputStream(NativeFile):
Examples
--------
Create an output stream wich compresses the data:
Create an output stream which compresses the data:
>>> import pyarrow as pa
>>> data = b"Compressed stream"
Expand Down Expand Up @@ -1818,7 +1818,7 @@ cdef class CompressedOutputStream(NativeFile):
Examples
--------
Create an output stream wich compresses the data:
Create an output stream which compresses the data:
>>> import pyarrow as pa
>>> data = b"Compressed stream"
Expand Down Expand Up @@ -2342,7 +2342,7 @@ cdef class CacheOptions(_Weakrefable):
def from_network_metrics(time_to_first_byte_millis, transfer_bandwidth_mib_per_sec,
ideal_bandwidth_utilization_frac=0.9, max_ideal_request_size_mib=64):
"""
Create suiteable CacheOptions based on provided network metrics.
Create suitable CacheOptions based on provided network metrics.
Typically this will be used with object storage solutions like Amazon S3,
Google Cloud Storage and Azure Blob Storage.
Expand Down
2 changes: 1 addition & 1 deletion python/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ requires = [
"cython >= 0.29.31",
# Starting with NumPy 1.25, NumPy is (by default) as far back compatible
# as oldest-support-numpy was (customizable with a NPY_TARGET_VERSION
# define). For older Python versions (where NumPy 1.25 is not yet avaiable)
# define). For older Python versions (where NumPy 1.25 is not yet available)
# continue using oldest-support-numpy.
"oldest-supported-numpy>=0.14; python_version<'3.9'",
"numpy>=1.25; python_version>='3.9'",
Expand Down

0 comments on commit 64a3768

Please sign in to comment.