Minor documentation updates

Author: mrbean-bremen

README.md

@@ -5,39 +5,29 @@ _pytest-order_ - a pytest plugin to order test execution
 
 `pytest-order` is a pytest plugin that allows you to customize the order in which
 your tests are run. It uses the marker `order` that defines when a specific
-test shall be run relative to the other tests.  
+test shall be run relative to the other tests. 
+
+`pytest-order` is a fork of
+[pytest-ordering](https://github.com/ftobia/pytest-ordering) that provides
+some additional features--see [below](#comparison-with-pytest_ordering) for
+details.
 
 `pytest-order` works with Python 2.7 and 3.5 - 3.9, with pytest 
 versions >= 3.7.0, and runs on Linux, MacOs and Windows.
 
-
 Documentation
 -------------
 Apart from this overview, the following information is available:
 - usage documentation for the [latest release](https://mrbean-bremen.github.io/pytest-order/stable/)
 - usage documentation for the [current master](https://mrbean-bremen.github.io/pytest-order/dev/)
 - the [Release Notes](https://github.com/mrbean-bremen/pytest-order/blob/master/CHANGELOG.md)
   with a list of changes in the latest versions
-
-History
--------
-This is a fork of [pytest-ordering](https://github.com/ftobia/pytest-ordering).
-That project is not maintained anymore, and there are several helpful PRs
-that are now integrated into `pytest-order`. The idea and most of the code
-has been created by Frank Tobia, the author of that plugin, and
-[contributors](https://github.com/mrbean-bremen/pytest-order/blob/master/AUTHORS).
-
-Compatibility with pytest_ordering
-----------------------------------
-`pytest-order` is **not** compatible with `pytest-ordering` due to the
-changed marker name (`order` instead of `run`). Only the `order` 
-marker is supported, support for all additional markers has been removed for
-consistence (as has been discussed in 
-[this issue](https://github.com/ftobia/pytest-ordering/issues/38)).
+- a [list of open issues](https://github.com/mrbean-bremen/pytest-order/blob/master/old_issues.md)
+  in the original project and their handling in `pytest-order`
 
 Overview
 --------
-_(from the original project)_
+_(adapted from the original project)_
 
 Have you ever wanted to easily run one of your tests before any others run?
 Or run some tests last? Or run this one test before that other test? Or
@@ -76,3 +66,31 @@ yields the output:
     test_foo.py:3: test_foo PASSED
 
     =========================== 2 passed in 0.01 seconds ===========================
+
+History
+-------
+This is a fork of [pytest-ordering](https://github.com/ftobia/pytest-ordering).
+That project is not maintained anymore, and there are several helpful PRs
+that are now integrated into `pytest-order`. The idea and most of the code
+has been created by Frank Tobia, the author of that plugin, and
+[contributors](https://github.com/mrbean-bremen/pytest-order/blob/master/AUTHORS).
+
+Comparison with pytest_ordering
+-------------------------------
+While derived from `pytest_ordering`, `pytest-order` is **not** compatible
+with `pytest-ordering` due to the changed marker name (`order` instead of
+`run`). Additional markers are integrated into the `order` marker (for a 
+rationale see also
+[this issue](https://github.com/ftobia/pytest-ordering/issues/38)).
+
+Apart from the changed marker name, there is a number of features not
+implemented in the released version of `pytest-ordering`:
+- support for ordering tests relative to each other 
+- support for module and class-scope ordering via a config option
+- optional support for ordering tests with `pytest-dependency` markers
+- optional support for sparse ordering
+- optional invocation of the plugin before (instead of after) other plugins
+
+Most of these features are derived from [issues](https://github.com/mrbean-bremen/pytest-order/blob/master/old_issues.md)
+and pull requests in `pytest-ordering`. A description of each feature can be
+found in the [documentation](https://mrbean-bremen.github.io/pytest-order/dev/).

docs/source/index.rst

@@ -245,8 +245,7 @@ By default, tests with no ``order`` mark are executed after all tests with
 positive ordinal numbers (or the respective names), and before tests with
 negative ordinal numbers. The order of these tests in relationship to each
 other is not changed. This behavior may slightly change if the option
-:ref:`sparse-ordering` is used and the ordinals are not contiguous (see
-below).
+:ref:`sparse-ordering` is used and the ordinals are not contiguous.
 
 
 Order relative to other tests
@@ -341,7 +340,7 @@ The `pytest-dependency <https://pypi.org/project/pytest-dependency/>`__
 plugin also manages dependencies between tests (skips tests that depend
 on skipped or failed tests), but currently doesn't do any ordering. If you
 want to execute the tests in a specific order to each other, you can use
-``pytest-ordering``. If you want to skip or xfail tests dependent on other
+``pytest-order``. If you want to skip or xfail tests dependent on other
 tests you can use ``pytest-dependency``. If you want to have both behaviors
 combined, you can use both plugins together with the
 option :ref:`order-dependencies`--see below for more information.
@@ -352,23 +351,6 @@ There are a few command line options that change the behavior of the
 plugin. As with any pytest option, you can add the options to your
 ``pytest.ini`` if you want to have them applied to all tests automatically.
 
-``--indulgent-ordering``
-------------------------
-You may sometimes find that you want to suggest an ordering of tests, while
-allowing it to be overridden for good reason. For example, if you run your test
-suite in parallel and have a number of tests which are particularly slow, it
-might be desirable to start those tests running first, in order to optimize
-your completion time. You can use the ``pytest-order`` plugin to inform pytest
-of this.
-
-Now suppose you also want to prioritize tests which failed during the
-previous run, by using the ``--failed-first`` option. By default,
-pytest-order will override the ``--failed-first`` order, but by adding the
-``--indulgent-ordering`` option, you can ask pytest to run the sort from
-pytest-order *before* the sort from ``--failed-first``, allowing the failed
-tests to be sorted to the front (note that in pytest versions from 6.0 on,
-this seems not to be needed anymore, at least in this specific case).
-
 .. _order-scope:
 
 ``--order-scope``
@@ -389,6 +371,23 @@ separate test functions, these test functions are handled separately from the
 test classes. If a module has no test classes, the effect is the same as
 if using ``--order-scope=module``.
 
+``--indulgent-ordering``
+------------------------
+You may sometimes find that you want to suggest an ordering of tests, while
+allowing it to be overridden for good reason. For example, if you run your test
+suite in parallel and have a number of tests which are particularly slow, it
+might be desirable to start those tests running first, in order to optimize
+your completion time. You can use the ``pytest-order`` plugin to inform pytest
+of this.
+
+Now suppose you also want to prioritize tests which failed during the
+previous run, by using the ``--failed-first`` option. By default,
+pytest-order will override the ``--failed-first`` order, but by adding the
+``--indulgent-ordering`` option, you can ask pytest to run the sort from
+pytest-order *before* the sort from ``--failed-first``, allowing the failed
+tests to be sorted to the front (note that in pytest versions from 6.0 on,
+this seems not to be needed anymore, at least in this specific case).
+
 .. _sparse-ordering:
 
 ``--sparse-ordering``

setup.cfg

@@ -1,4 +1,5 @@
 [metadata]
 description-file = README.md
+license_files = LICENSE
 [bdist_wheel]
 universal=1

setup.py

@@ -21,6 +21,7 @@
     author_email="[email protected]",
     url="https://github.com/mrbean-bremen/pytest-order",
     packages=["pytest_order"],
+    license="MIT",
     entry_points={
         "pytest11": [
             "pytest_order = pytest_order",