Skip to content

Commit 3aa4cef

Browse files
committed
clarify some sections
1 parent f0b01ec commit 3aa4cef

4 files changed

Lines changed: 14 additions & 12 deletions

File tree

docs/source/how_to_guides/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ specific tasks with pytask.
1010
- [Migrating From Scripts To Pytask](migrating_from_scripts_to_pytask.md)
1111
- [Interfaces For Dependencies Products](interfaces_for_dependencies_products.md)
1212
- [Move a Project to Another Machine](move_project_to_another_machine.md)
13-
- [Update the Lockfile to Match Project State](reconciling_lockfile_state.md)
13+
- [Update the Lockfile to Match Project State](update_the_lockfile_to_match_project_state.md)
1414
- [Remote Files](remote_files.md)
1515
- [Functional Interface](functional_interface.md)
1616
- [Capture Warnings](capture_warnings.md)

docs/source/how_to_guides/reconciling_lockfile_state.md renamed to docs/source/how_to_guides/update_the_lockfile_to_match_project_state.md

File renamed without changes.

docs/source/tutorials/set_up_a_project.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -133,22 +133,24 @@ The `[tool.pytask.ini_options]` section tells pytask to look for tasks in
133133
`src/my_project`. You will learn more about configuration in the
134134
[configuration tutorial](configuration.md).
135135

136-
## The `.pytask` directory
137-
138-
The `.pytask` directory is where pytask stores its information. You do not need to
139-
interact with it.
140-
141136
## The `pytask.lock` file
142137

143138
The `pytask.lock` file records which tasks and products are up to date. pytask updates
144139
it during builds so later runs can skip unchanged tasks. This file should be kept in
145140
version control.
146141

147-
When you move a project to another machine, see
148-
[Move a Project to Another Machine](../how_to_guides/move_project_to_another_machine.md).
149-
To update recorded task state manually, use
150-
[`pytask lock`](../reference_guides/commands.md#pytask-lock). For details on what pytask
151-
stores in the file, see [Lockfile](../reference_guides/lockfile.md).
142+
!!! seealso
143+
144+
You will later learn how to sync the state of the lockfile with the project state with
145+
the [`pytask lock`](../reference_guides/commands.md#pytask-lock) command or how the
146+
lockfile enables you to
147+
[move a project to another machine](../how_to_guides/move_project_to_another_machine.md),
148+
but don't worry about it for now.
149+
150+
## The `.pytask` directory
151+
152+
The `.pytask` directory is where pytask stores some of its ephemeral information. You do
153+
not need to interact with it, nor do you need to keep it in version control.
152154

153155
## Installation
154156

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ nav:
3838
- Migrating From Scripts To pytask: how_to_guides/migrating_from_scripts_to_pytask.md
3939
- Interfaces For Dependencies And Products: how_to_guides/interfaces_for_dependencies_products.md
4040
- Move a Project to Another Machine: how_to_guides/move_project_to_another_machine.md
41-
- Reconciling Lockfile State: how_to_guides/reconciling_lockfile_state.md
41+
- Update the Lockfile to Match Project State: how_to_guides/update_the_lockfile_to_match_project_state.md
4242
- Remote Files: how_to_guides/remote_files.md
4343
- Functional Interface: how_to_guides/functional_interface.md
4444
- Capture Warnings: how_to_guides/capture_warnings.md

0 commit comments

Comments
 (0)