Skip to content

Commit e2a5b4e

Browse files
authored
MINOR: [Docs] Fix typos in rst files (#46335)
### Rationale for this change Improving docs by removing typos ### What changes are included in this PR? Fix typos in rst files ### Are these changes tested? Documentation-only changes ### Are there any user-facing changes? Documentation-only changes Authored-by: omahs <[email protected]> Signed-off-by: Sutou Kouhei <[email protected]>
1 parent 2a88c52 commit e2a5b4e

File tree

7 files changed

+13
-13
lines changed

7 files changed

+13
-13
lines changed

docs/source/cpp/env_vars.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ that changing their value later will have an effect.
145145

146146
By default, Arrow C++ detects the capabilities of the current CPU at runtime
147147
and chooses the best execution paths based on that information. This
148-
behavior can be overriden by setting this environment variable to a
148+
behavior can be overridden by setting this environment variable to a
149149
well-defined value. Supported values are:
150150

151151
- ``NONE`` disables any runtime-selected SIMD optimization;

docs/source/developers/benchmarks.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -159,9 +159,9 @@ Writing a benchmark
159159
By contrast to realtime which is the wall clock time, e.g. the difference
160160
between end_time - start_time. In a single thread model, the cputime is
161161
preferable since it is less affected by context switching. In a multi thread
162-
scenario, the cputime will give incorrect result since the since it'll
163-
be inflated by the number of threads and can be far off realtime. Thus, if
164-
the benchmark is multi threaded, it might be better to use
162+
scenario, the cputime will give incorrect result since it'll be inflated by
163+
the number of threads and can be far off realtime. Thus, if the benchmark is
164+
multi threaded, it might be better to use
165165
``SetRealtime()``, see this `example <https://github.com/apache/arrow/blob/a9582ea6ab2db055656809a2c579165fe6a811ba/cpp/src/arrow/io/memory-benchmark.cc#L223-L227>`_.
166166

167167
Scripting

docs/source/developers/bug_reports.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ reached a terminal status, it is closed with one of two outcomes:
200200

201201
If you are merging a PR it is good practice to add a comment
202202
to the linked issue about which PR is resolving it. This way
203-
GitHub crates a notification for anybody that collaborated on
203+
GitHub creates a notification for anybody that collaborated on
204204
the issue.
205205

206206
* **closed as not planned** - indicates the issue is closed and should

docs/source/developers/continuous_integration/overview.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,11 @@ Continuous Integration for Arrow is fairly complex as it needs to run across dif
2424

2525
Some files central to Arrow CI are:
2626

27-
- ``docker-compose.yml`` - here we define docker services which can be configured using either enviroment variables, or the default values for these variables.
27+
- ``docker-compose.yml`` - here we define docker services which can be configured using either environment variables, or the default values for these variables.
2828
- ``.env`` - here we define default values to configure the services in ``docker-compose.yml``
2929
- ``appveyor.yml`` - here we define workflows that run on Appveyor
3030

31-
We use :ref:`Docker<docker-builds>` in order to have portable and reproducible Linux builds, as well as running Windows builds in Windows containers. We use :ref:`Archery<Archery>` and :ref:`Crossbow<Crossbow>` to help co-ordinate the various CI tasks.
31+
We use :ref:`Docker<docker-builds>` in order to have portable and reproducible Linux builds, as well as running Windows builds in Windows containers. We use :ref:`Archery<Archery>` and :ref:`Crossbow<Crossbow>` to help coordinate the various CI tasks.
3232

3333
One thing to note is that some of the services defined in ``docker-compose.yml`` are interdependent. When running services locally, you must either manually build its dependencies first, or build it via the use of ``archery docker run ...`` which automatically finds and builds dependencies.
3434

@@ -69,6 +69,6 @@ Crossbow is a subcomponent of Archery and can be used to manually trigger builds
6969
- the file ``dev/tasks/tasks.yml`` containing the configuration for various tasks which can be run via Crossbow
7070
- subdirectories containing different task templates (specified using `jinja2 syntax <https://jinja.palletsprojects.com/>`_), divided roughly by language or package management system.
7171

72-
Most of these tasks are run as part of the nightly builds, though they can also be triggered manually by add a comment to a PR which begins with ``@github-actions crossbow submit`` followed by the name of the task to be run.
72+
Most of these tasks are run as part of the nightly builds, though they can also be triggered manually by adding a comment to a PR which begins with ``@github-actions crossbow submit`` followed by the name of the task to be run.
7373

7474
For convenience purpose, the tasks in ``dev/tasks/tasks.yml`` are defined in groups, which makes it simpler for multiple tasks to be submitted to Crossbow at once. The task definitions here contain information about which service defined in ``docker-compose.yml`` to run, the CI service to run the task on, and which template file to use as the basis for that task.

docs/source/developers/python.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -646,7 +646,7 @@ PyArrow are:
646646
- Number of processes used to compile PyArrow’s C++/Cython components
647647
- ``''``
648648

649-
The components being disabled or enabled when building PyArrrow is by default
649+
The components being disabled or enabled when building PyArrow is by default
650650
based on how Arrow C++ is build (i.e. it follows the ``ARROW_$COMPONENT`` flags).
651651
However, the ``PYARROW_WITH_$COMPONENT`` environment variables can still be used
652652
to override this when building PyArrow (e.g. to disable components, or to enforce

docs/source/developers/release.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -107,11 +107,11 @@ for specific builds and others.
107107
Any developer can ask for a patch release to be generated sending an email to the
108108
`Arrow development mailing-list <https://arrow.apache.org/community/>`__ with the reason
109109
of why a new release is necessary.
110-
If there is consensus and there is a Release Manager willing to take the effort to create
110+
If there is consensus and there is a Release Manager willing to make the effort to create
111111
the release a patch release can be created.
112112

113113
Committers can tag issues that should be included on the next patch release using the
114-
``backport-candidate`` label. Is the responsability of the author or the committer to add the
114+
``backport-candidate`` label. Is the responsibility of the author or the committer to add the
115115
label to the issue to help the Release Manager identify the issues that should be backported.
116116

117117
If a specific issue is identified as the reason to create a patch release the Release Manager
@@ -185,7 +185,7 @@ Some release managers prefer to perform testing before creating the first
185185
release candidate to avoid the need to create multiple release candidates within
186186
a given release.
187187

188-
To test before creating a release candiate:
188+
To test before creating a release candidate:
189189

190190
* Create a pull request from the up-to-date maint-X.Y.Z branch onto main
191191
* Title the pull request "WIP: Dummy PR to check maint-X.Y.Z status"

docs/source/format/DissociatedIPC.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -359,7 +359,7 @@ showing how a client might handle the metadata and data streams:
359359
be used alongside the sequence number to match the message regardless of the higher bytes (e.g. we only
360360
care about matching the lower 4 bytes to the sequence number)
361361

362-
* Once recieved, the Most Significant Byte's value determines how the client processes the body data:
362+
* Once received, the Most Significant Byte's value determines how the client processes the body data:
363363

364364
* If the most significant byte is 0: Then the body of the message is the raw IPC packed body buffers
365365
allowing it to easily be processed with the corresponding metadata header bytes.

0 commit comments

Comments
 (0)