Skip to content

Commit

Permalink
Minor Update.
Browse files Browse the repository at this point in the history
  • Loading branch information
huxuan committed Feb 5, 2024
1 parent dcd722b commit 1492a94
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions docs/dev/dev-env.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,23 +40,23 @@ When encountering environment-related problems. A straightforward solution is to

### Intermediate cleanup

Intermediate cleanup will only remove common intermediate files, such as generated documentation, package, coverage report, cache files for mypy, pytest, ruff and so on.
Intermediate cleanup only removes common intermediate files, such as generated documentation, package, coverage report, cache files for mypy, pytest, ruff and so on.

```bash
make clean
```

### Deep cleanup

Deep cleanup will remove the pre-commit hook and the virtual environment alongside the common intermediate files.
Deep cleanup removes the pre-commit hook and the virtual environment alongside the common intermediate files.

```bash
make deepclean
```

### Complete cleanup

Complete cleanup will make the repo as if it has been re-cloned. It is useful if we want to start from scratch.
Complete cleanup restores the repository to its original, freshly-cloned state, ideal for starting over from scratch.

```{caution}
This will remove all untracked files, please use it with caution. It is recommended to check with dry-run mode (`git clean -dfnx`) before actually removing anything. For more information, please refer to the [git-clean documentation](https://git-scm.com/docs/git-clean).
Expand Down
6 changes: 3 additions & 3 deletions template/docs/dev/dev-env.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,23 +40,23 @@ When encountering environment-related problems. A straightforward solution is to

### Intermediate cleanup

Intermediate cleanup will only remove common intermediate files, such as generated documentation, package, coverage report, cache files for mypy, pytest, ruff and so on.
Intermediate cleanup only removes common intermediate files, such as generated documentation, package, coverage report, cache files for mypy, pytest, ruff and so on.

```bash
make clean
```

### Deep cleanup

Deep cleanup will remove the pre-commit hook and the virtual environment alongside the common intermediate files.
Deep cleanup removes the pre-commit hook and the virtual environment alongside the common intermediate files.

```bash
make deepclean
```

### Complete cleanup

Complete cleanup will make the repo as if it has been re-cloned. It is useful if we want to start from scratch.
Complete cleanup restores the repository to its original, freshly-cloned state, ideal for starting over from scratch.

```{caution}
This will remove all untracked files, please use it with caution. It is recommended to check with dry-run mode (`git clean -dfnx`) before actually removing anything. For more information, please refer to the [git-clean documentation](https://git-scm.com/docs/git-clean).
Expand Down

0 comments on commit 1492a94

Please sign in to comment.