Skip to content

Commit cb2dcc2

Browse files
committed
Fix: rename section for shorter url
1 parent ec0255c commit cb2dcc2

File tree

4 files changed

+21
-18
lines changed

4 files changed

+21
-18
lines changed

index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ Packaging <package-structure-code/intro>
1818

1919
```{toctree}
2020
:hidden:
21-
:caption: CI and Testing
21+
:caption: Testing
2222
23-
CI & Tests <ci-tests-data/index>
23+
Tests <tests/index>
2424
2525
```
2626

ci-tests-data/index.md renamed to tests/index.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,12 @@
11
# Tests and data for your Python package
22

3-
In this section you will learn more about the importance of writing
4-
tests for your Python package.
5-
6-
7-
:::{figure-md} fig-target
8-
9-
<img src="../images/packaging-lifecycle.png" alt="" width="800px">
10-
11-
Graphic showing the elements of the packaging process.
12-
:::
3+
Tests are an important part of your Python package because they
4+
provide a set of checks that ensure that your package is
5+
functioning how you expect it to.
136

7+
In this section you will learn more about the importance of writing
8+
tests for your Python package and how you can setup infrastructure
9+
to run your tests both locally and on GitHub.
1410

1511

1612
::::{grid} 1 1 3 3
@@ -52,6 +48,14 @@ your computer and using continuous integration on GitHub (or in any other CI).
5248
:::
5349
::::
5450

51+
52+
:::{figure-md} fig-target
53+
54+
<img src="../images/packaging-lifecycle.png" alt="" width="800px">
55+
56+
Graphic showing the elements of the packaging process.
57+
:::
58+
5559
```{toctree}
5660
:hidden:
5761
:maxdepth: 2

ci-tests-data/test-types.md renamed to tests/test-types.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Test Types for Python packages
22

3-
_Unit, Integration & Functional Tests_
3+
## Three types of tests: Unit, Integration & Functional Tests
44

55
There are different types of tests that you want to consider when creating your
66
test suite:
@@ -11,11 +11,10 @@ test suite:
1111

1212
Each type of test has a different purpose. Here, you will learn about all three types of tests.
1313

14-
```{admonition}
14+
```{todo}
1515
I think this page would be stronger if we did have some
1616
examples from our package here: https://github.com/pyOpenSci/pyosPackage
1717
18-
1918
```
2019

2120
## Unit Tests
@@ -70,7 +69,7 @@ def test_celsius_to_fahrenheit():
7069
Your unit tests should ensure each part of your code works as expected on its own.
7170
```
7271

73-
### Integration tests
72+
## Integration tests
7473

7574
Integration tests involve testing how parts of your package work together or integrate. Integration tests can be compared to connecting a bunch of puzzle pieces together to form a whole picture. Integration tests focus on how different pieces of your code fit and work together.
7675

@@ -122,7 +121,7 @@ together, do so as expected.
122121
123122
```
124123

125-
### End-to-end (functional) tests
124+
## End-to-end (functional) tests
126125

127126
End-to-end tests (also referred to as functional tests) in Python are like comprehensive checklists for your software. They simulate real user end-to-end workflows to make sure the code base supports real life applications and use-cases from start to finish. These tests help catch issues that might not show up in smaller tests and ensure your entire application or program behaves correctly. Think of them as a way to give your software a final check before it's put into action, making sure it's ready to deliver a smooth experience to its users.
128127

@@ -141,7 +140,7 @@ End-to-end test also test how a program runs from start to finish. A tutorial th
141140
For scientific packages, creating short tutorials that highlight core workflows that your package supports, that are run when your documentation is built could also serve as end-to-end tests.
142141
```
143142

144-
### Comparing unit, integration and end-to-end tests
143+
## Comparing unit, integration and end-to-end tests
145144

146145
Unit tests, integration tests, and end-to-end tests have complementary advantages and disadvantages. The fine-grained nature of unit tests make them well-suited for isolating where errors are occurring. However, unit tests are not useful for verifying that different sections of code work together.
147146

File renamed without changes.

0 commit comments

Comments
 (0)