Skip to content

Commit e641f5a

Browse files
committed
Structure examples according to documentation
- add some missing examples - fix documentation links in examples - change development status to stable
1 parent 06c0456 commit e641f5a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+248
-65
lines changed

CHANGELOG.md

Lines changed: 5 additions & 0 deletions

README.md

Lines changed: 1 addition & 1 deletion

docs/source/usage.rst

Lines changed: 2 additions & 1 deletion

example/README

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
This directory contains the example code as used in the documentation.
2+
Each example contains a link to the related documentation chapter.
3+
Refer to that documentation for usage.

example/test_sort_breaks_dependency.py renamed to example/configuration/order_dependencies/test_sort_breaks_dependency.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
"""Test showing that sorting is not done if it would break an existing
2-
dependency.
3-
See https://pytest-order.readthedocs.io/en/stable/#order-dependencies
1+
"""Test showing that sorting is not done if it would break an existing dependency.
2+
See https://pytest-order.readthedocs.io/en/stable/configuration.html#order-dependencies
43
"""
54

65
import pytest

example/test_sort_dependency.py renamed to example/configuration/order_dependencies/test_sort_dependency.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""Test showing the behavior of the --order-dependencies option.
2-
See https://pytest-order.readthedocs.io/en/stable/#order-dependencies
2+
See https://pytest-order.readthedocs.io/en/stable/configuration.html#order-dependencies
33
"""
44

55
import pytest
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
"""One of the test files showing the use of the --order-group-scope option.
2+
See https://pytest-order.readthedocs.io/en/stable/configuration.html#order-group-scope
3+
"""
4+
5+
import pytest
6+
7+
8+
@pytest.mark.order(2)
9+
def test1():
10+
pass
11+
12+
13+
def test2():
14+
pass
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
"""One of the test files showing the use of the --order-group-scope option.
2+
See https://pytest-order.readthedocs.io/en/stable/configuration.html#order-group-scope
3+
"""
4+
5+
import pytest
6+
7+
8+
@pytest.mark.order(1)
9+
def test1():
10+
pass
11+
12+
13+
def test2():
14+
pass

0 commit comments

Comments
 (0)