You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/template_usage.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -123,7 +123,7 @@ While [codecov docs][] has a very extensive documentation on how to get started,
123
123
To set it up, simply go to the [codecov app][] page and follow the instructions to activate it for your repository.
124
124
Once the activation is completed, go back to the `Actions` tab and re-run the failing workflows.
125
125
126
-
The workflows should now succeed and you will be able to find the code coverage at this link: `https://app.codecov.io/gh/scverse/cookiecutter-scverse-instance`. You might have to wait couple of minutes and the coverage of this repository should be ~60%.
126
+
The workflows should now succeed, and you will be able to find the code coverage at this link: `https://app.codecov.io/gh/scverse/cookiecutter-scverse-instance`. You might have to wait a couple of minutes and the coverage of this repository should be ~60%.
127
127
128
128
If your repository is private, you will have to specify an additional token in the repository secrets. In brief, you need to:
129
129
@@ -150,7 +150,7 @@ On the RTD dashboard choose "Import a Project" and follow the instructions to ad
150
150
151
151
- Make sure to choose the correct name of the default branch. On GitHub, the name of the default branch should be `main` (it has
152
152
recently changed from `master` to `main`).
153
-
- We recommend to enable documentation builds for pull requests (PRs). This ensures that a PR doesn't introduce changes
153
+
- We recommend enabling documentation builds for pull requests (PRs). This ensures that a PR doesn't introduce changes
154
154
that break the documentation. To do so, got to `Admin -> Advanced Settings`, check the
155
155
`Build pull requests for this projects` option, and click `Save`. For more information, please refer to
156
156
the [official RTD documentation](https://docs.readthedocs.io/en/stable/pull-requests.html).
@@ -373,7 +373,7 @@ The following hints may be useful to work with the template sync:
373
373
## Moving forward
374
374
375
375
You have reached the end of this document. Congratulations! You have successfully set up your project and are ready to start.
376
-
For everything else related to documentation, code style, testing and publishing your project ot pypi, please refer to the [contributing docs](contributing.md#contributing-guide).
376
+
For everything else related to documentation, code style, testing and publishing your project to pypi, please refer to the [contributing docs](contributing.md#contributing-guide).
0 commit comments