Spelling #12122

jsoref · 2024-03-15T17:32:45Z

I'm open to adding a changelog item, but as I generally get pushback on some changes in long sets, I'm disinclined to write it proactively as I don't know what it'll say.

Fwiw, here's the tooling output that reported the items that I'm fixing: https://github.com/jsoref/pytest/actions/runs/8286348273#summary-22676128090
And here's a report showing those items have been addressed: https://github.com/jsoref/pytest/actions/runs/8286348842#summary-22676129381

Ensure all uses of caplog._item have a comment highlighting it is a private API and not for use in real tests!

All the tests in this file are tests of `caplog`

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

for more information, see https://pre-commit.ci

jsoref · 2024-03-15T17:35:19Z

doc/en/announce/release-2.0.0.rst

- many many more detailed improvements details
+- many, many, more detailed improvements details


generally in English, doubled words aren't appropriate without punctuation, and often they're just errant.

jsoref · 2024-03-15T17:35:47Z

doc/en/announce/release-2.4.0.rst

-  module-level functions.  Thanks Anatloy Bubenkoff.
+  module-level functions.  Thanks Anatoly Bubenkoff.


This matches other instances of what I have to presume is the same entity.

jsoref · 2024-03-15T17:36:15Z

doc/en/announce/release-2.5.0.rst

-  indices for paramentrized test ids
+  indices for parametrized test ids


there's an amusing thing elsewhere about a serious of variations of this word, but this isn't one of them...

jsoref · 2024-03-15T17:36:58Z

doc/en/announce/release-2.6.0.rst

- change XPASS colour to yellow rather then red when tests are run
+- change XPASS colour to yellow rather than red when tests are run


technically this is grammatical, but most spell checkers have been able to flag rudimentary grammar errors, so there are a handful of fixes for things like this...

jsoref · 2024-03-15T17:37:58Z

doc/en/changelog.rst

-  pytest used to silently use a pre-existing ``/tmp/pytest-of-<username>`` directory,
+  pytest used to silently use a preexisting ``/tmp/pytest-of-<username>`` directory,


both flavors were preexisting in this repository :)

jsoref · 2024-03-15T17:40:06Z

doc/en/naming20.rst

-Python module flaty provides the same objects, following
+Python module flatly provides the same objects, following


It could be that there's a module flaty, but...

jsoref · 2024-03-15T17:40:55Z

doc/en/reference/plugin_list.rst

@@ -47,7 +47,7 @@ This list contains 1411 plugins.
   :pypi:`pytest-adf-azure-identity`                Pytest plugin for writing Azure Data Factory integration tests                                                                                                                                                                                                                                                                                                                          Mar 06, 2021    4 - Beta               pytest (>=3.5.0)
   :pypi:`pytest-ads-testplan`                      Azure DevOps Test Case reporting for pytest tests                                                                                                                                                                                                                                                                                                                                       Sep 15, 2022    N/A                    N/A
   :pypi:`pytest-affected`                                                                                                                                                                                                                                                                                                                                                                                                                  Nov 06, 2023    N/A                    N/A
-   :pypi:`pytest-agent`                             Service that exposes a REST API that can be used to interract remotely with Pytest. It is shipped with a dashboard that enables running tests in a more convenient way.                                                                                                                                                                                                                 Nov 25, 2021    N/A                    N/A
+   :pypi:`pytest-agent`                             Service that exposes a REST API that can be used to interact remotely with Pytest. It is shipped with a dashboard that enables running tests in a more convenient way.                                                                                                                                                                                                                 Nov 25, 2021    N/A                    N/A


I couldn't tell if this is a list of descriptions that come from the modules, in which case the fixes would belong in the modules -- but searches didn't seem to show lots of indications where I'd expect if that was the case, so...

src/_pytest/legacypath.py

jsoref · 2024-03-15T17:42:34Z

src/_pytest/stepwise.py

@@ -40,7 +40,7 @@ def pytest_addoption(parser: Parser) -> None:
 @pytest.hookimpl
 def pytest_configure(config: Config) -> None:
    if config.option.stepwise_skip:
-        # allow --stepwise-skip to work on it's own merits.
+        # allow --stepwise-skip to work on its own merits.


the previous text would mean it is which seems very wrong

jsoref · 2024-03-15T17:44:16Z

testing/test_runner.py

-        # assert instanace(rep.failed.failurerepr, PythonFailureRepr)
+        # assert isinstance(rep.failed.failurerepr, PythonFailureRepr)


It's possible this was instance, but I didn't think that was a thing

nicoddemus

Looks great, thanks!

Usually we would squash the commits before merging for a mostly automated PR like this one, but perhaps it makes sense to keep those commits because they do add context to each change?

nicoddemus · 2024-03-16T13:44:34Z

doc/en/deprecations.rst

@@ -427,7 +427,7 @@ Now :class:`~pytest.Class` collects the test methods directly.
 Most plugins which reference ``Instance`` do so in order to ignore or skip it,
 using a check such as ``if isinstance(node, Instance): return``.
 Such plugins should simply remove consideration of ``Instance`` on pytest>=7.
-However, to keep such uses working, a dummy type has been instanted in ``pytest.Instance`` and ``_pytest.python.Instance``,
+However, to keep such uses working, a dummy type has been instanced in ``pytest.Instance`` and ``_pytest.python.Instance``,


Both work I think?

nicoddemus · 2024-03-16T13:45:48Z

doc/en/reference/plugin_list.rst

The descriptions here are taken from PyPI and are generated automatically, so they will be overwritten on the next update, but this is fine.

src/_pytest/legacypath.py

jsoref · 2024-05-15T14:51:17Z

@nicoddemus: are you waiting for something from me?

nicoddemus · 2024-05-15T16:48:58Z

@jsoref no, thanks for the ping. I was waiting to see if others would like to review too, but merging now.

jsoref added 30 commits March 14, 2024 09:46

Refactor private_assert_caplog_records_is_setup_call

77647e4

Ensure all uses of caplog._item have a comment highlighting it is a private API and not for use in real tests!

Remove _caplog_ from test name

8fe62f6

All the tests in this file are tests of `caplog`

spelling: already

a7abe2c

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: analysis pipelines

3ff72df

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: anatoly

f016f51

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: and

7484a84

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: automatically

4b16fb6

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: bootstrapping

de585d1

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: cachefile

a045234

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: cannot

d414d4f

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: case-insensitive

a0b1f52

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: collection

13bfc38

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: completion

bf1103a

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: consuming

e6e06e2

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: copy

34060ef

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: coroutine

ab8cc1f

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: deprecation

ef9b183

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: details

05b212a

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: discussions

6ed10f4

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: doctest

fa75c3f

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: doctests

4bff7d5

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: errors

35533bd

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: escaped

d6cc4d3

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: evaluable

3f6acbb

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: failures

fa1e25d

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: fine-grained

5694d5a

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: fixes

82fb1dc

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: fixturedef

8a66f76

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: flatly

e721a20

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: forward

482d011

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

jsoref and others added 21 commits March 14, 2024 10:05

spelling: pytest

faa2f2e

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: raised

d372ff2

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: reentrant

2a12477

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: regression

ea949ce

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: report

57f9adc

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: rootpath

07268b5

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: running

90a8c4e

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: something

8406e52

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: startdir

033dc5f

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: suppressing

0fd50b8

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: synchronize

da213cf

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: than

6414d1a

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: thanks

0b0ce2d

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: that

cfcd16f

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: the

b9176fa

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: torn_down

adbe684

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: unaffected

607cc88

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: unavailable

eb387a1

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: undoes

a72f482

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: visibility

c20f544

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

[pre-commit.ci] auto fixes from pre-commit.com hooks

4988031

for more information, see https://pre-commit.ci

jsoref commented Mar 15, 2024

View reviewed changes

Revert changes to plugin_list.rst: generated automatically

d219472

nicoddemus approved these changes Mar 16, 2024

View reviewed changes

nicoddemus merged commit 8d00811 into pytest-dev:main May 15, 2024
24 checks passed

nicoddemus added the backport 8.2.x Apply on merged PRs, backports the changes to the 8.2.x branch label May 15, 2024

github-actions bot mentioned this pull request May 15, 2024

[8.2.x] Spelling #12331

Merged

jsoref deleted the spelling branch May 15, 2024 16:56

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Spelling #12122

Spelling #12122

jsoref commented Mar 15, 2024

jsoref Mar 15, 2024

jsoref Mar 15, 2024

jsoref Mar 15, 2024

jsoref Mar 15, 2024

jsoref Mar 15, 2024

jsoref Mar 15, 2024

jsoref Mar 15, 2024

jsoref Mar 15, 2024

jsoref Mar 15, 2024

nicoddemus left a comment

nicoddemus Mar 16, 2024

nicoddemus Mar 16, 2024

jsoref commented May 15, 2024

nicoddemus commented May 15, 2024

		- many many more detailed improvements details
		- many, many, more detailed improvements details

		module-level functions. Thanks Anatloy Bubenkoff.
		module-level functions. Thanks Anatoly Bubenkoff.

		indices for paramentrized test ids
		indices for parametrized test ids

		- change XPASS colour to yellow rather then red when tests are run
		- change XPASS colour to yellow rather than red when tests are run

		pytest used to silently use a pre-existing ``/tmp/pytest-of-<username>`` directory,
		pytest used to silently use a preexisting ``/tmp/pytest-of-<username>`` directory,

		Python module flaty provides the same objects, following
		Python module flatly provides the same objects, following

		# assert instanace(rep.failed.failurerepr, PythonFailureRepr)
		# assert isinstance(rep.failed.failurerepr, PythonFailureRepr)

Spelling #12122

Spelling #12122

Conversation

jsoref commented Mar 15, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nicoddemus left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jsoref commented May 15, 2024

nicoddemus commented May 15, 2024