Skip to content

Commit c94b8b7

Browse files
committed
Update some more tutorials.
1 parent aa4d8ea commit c94b8b7

File tree

4 files changed

+12
-14
lines changed

4 files changed

+12
-14
lines changed

docs/source/tutorials/cleaning_projects.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Projects usually become cluttered with obsolete files after some time.
44

5-
To clean the project, type
5+
To clean the project, type `pytask clean`
66

77
```{image} /_static/images/clean-dry-run.svg
88
```

docs/source/tutorials/markers.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,9 @@ available markers by using the `pytask markers` command.
66
```{image} /_static/images/markers.svg
77
```
88

9-
You can use your own markers to select tasks as explained in this
10-
{ref}`tutorial <markers>`.
9+
You can use your markers to select tasks as explained in this {ref}`tutorial <markers>`.
1110

12-
If you create your own marker, register it in the configuration file with its name and a
11+
If you create your marker, register it in the configuration file with its name and a
1312
description.
1413

1514
```toml

docs/source/tutorials/plugins.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
11
# Plugins
22

3-
Since pytask is used in many different contexts, all possible applications are
4-
unforeseeable and cannot be directly supported by pytask's developers.
3+
Users employ pytask in many different contexts, making it impossible for pytask's
4+
maintainers to support all possible use-cases.
55

6-
Therefore, pytask is built upon [pluggy](https://github.com/pytest-dev/pluggy), a plugin
7-
framework also used in pytest which allows other developers to extend pytask.
6+
Therefore, pytask uses [pluggy](https://github.com/pytest-dev/pluggy), a plugin
7+
framework, for allowing users to extend pytask.
88

99
## Where to find plugins
1010

11-
Plugins can be found in many places.
11+
You can find plugins in many places.
1212

13-
- All plugins should appear in this {doc}`automatically updated list <../plugin_list>`
13+
- All plugins should appear in this {doc}`automatically updated list <../plugin_list>`,
1414
which is created by scanning packages on PyPI.
1515
- Check out the repositories in the [pytask-dev](https://github.com/pytask-dev) Github
1616
organization for a collection of officially supported plugins.
17-
- Check out the [pytask Github topic](https://github.com/topics/pytask) which shows an
17+
- Check out the [pytask Github topic](https://github.com/topics/pytask), which shows an
1818
overview of repositories linked to pytask.
1919
- Search on [anaconda.org](https://anaconda.org/search?q=pytask) for related packages.
2020

21-
## How to implement your own plugin
21+
## How to implement your plugin
2222

2323
Follow the {doc}`guide on writing a plugin <../how_to_guides/how_to_write_a_plugin>` to
2424
write your own plugin.

docs/source/tutorials/profiling_tasks.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# Profiling tasks
22

3-
pytask collects information on the runtime of tasks when they finished successfully. To
4-
display the information, enter
3+
pytask collects information on tasks when they succeed. To display the data, enter
54

65
```console
76
$ pytask profile

0 commit comments

Comments
 (0)