Skip to content

Commit 6b0fcb5

Browse files
authored
Merge pull request #227 from JostMigenda/patch-1
Fix typos, remove dead links
2 parents 3224d1c + 5d1a7ab commit 6b0fcb5

2 files changed

Lines changed: 10 additions & 20 deletions

File tree

content/continuous-integration.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,7 @@ in the [Collaborative Git lesson](https://coderefinery.github.io/git-collaborati
194194

195195
#### Fork and clone an existing example repository
196196

197-
- Fork the example repo. There are two options one for [python](https://github.com/AaltoRSE/PyTestingExample) and one for [R](https://github.com/AaltoRSE/RTestingExample).
197+
- Fork the example repo. There are two options one for [Python](https://github.com/AaltoRSE/PyTestingExample) and one for [R](https://github.com/AaltoRSE/RTestingExample).
198198
- Clone your fork (`git clone git@github.com:<yourGitID>/<Py/R>TestingExample.git`).
199199

200200

@@ -234,7 +234,7 @@ in the [Collaborative Git lesson](https://coderefinery.github.io/git-collaborati
234234
```
235235
236236
GitHub creates the following file for you in the subfolder `.github/workflows`.
237-
Modify the highlited lines according to the action below. This will add a code coverage
237+
Modify the highlighted lines according to the action below. This will add a code coverage
238238
report to new pull requests. The if clause restricts this to pull requests, as otherwise
239239
this action would not have a target to write the reports to. On pushes only the unittesting is run.
240240
@@ -321,7 +321,7 @@ in the [Collaborative Git lesson](https://coderefinery.github.io/git-collaborati
321321
- test
322322
before_script:
323323
- cat /proc/version #print out operations system
324-
- python -V # Print out python version for debugging
324+
- python -V # Print out Python version for debugging
325325
- pip install pytest flake8
326326
- if [ -f requirements.txt ]; then pip install -r requirements.txt;fi
327327
@@ -552,14 +552,14 @@ the commit message or the pull/merge request contained the correct issue number)
552552

553553
See also:
554554
- GitHub: [closing issues using keywords](https://help.github.com/articles/closing-issues-using-keywords/)
555-
- GitLab: [closing issues using keywords](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues)
555+
- GitLab: [closing issues using keywords](https://docs.gitlab.com/user/project/issues/managing_issues/#closing-issues-automatically)
556556

557557
Discuss whether this is a useful feature. And if it is, why do you think is it useful?
558558

559559
### Step 10: Increase your code coverage
560560

561561
We are currently missing several functions in our tests. Write a test for the `multiply` function in a new branch and create a pull request.
562-
On python you can directly observe the increase in code coverage.
562+
On Python you can directly observe the increase in code coverage.
563563
On R you can have a look at the action (`Actions -> last run of your action -> Select a job -> Test coverage`). If you compare this with the
564564
previous run, you should see an increase once the update is in.
565565

@@ -582,7 +582,7 @@ Finally, we discuss together about our experiences with this exercise.
582582
[centralized](https://coderefinery.github.io/git-collaborative/02-centralized/) and
583583
[forking](https://coderefinery.github.io/git-collaborative/03-distributed/) workflows - have a look at this
584584
[alternative exercise](./full-cycle-ci) to see how that works.
585-
- GitHub Actions has a [Marketpace](https://github.com/marketplace?type=actions) which offer wide range of automatic workflows
585+
- GitHub Actions has a [Marketplace](https://github.com/marketplace?type=actions) which offer wide range of automatic workflows
586586
- On GitLab use [GitLab CI](https://about.gitlab.com/product/continuous-integration/)
587587
- For Windows builds you can also use [Appveyor](https://www.appveyor.com)
588588

content/quick-reference.md

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,10 @@ script which does some tests.
3939

4040
(pytest-ref)=
4141

42-
### pytest_
42+
### pytest
4343

4444
- Python
45-
- <http://doc.pytest.org>
45+
- <https://docs.pytest.org/>
4646
- Installable via Conda or pip.
4747
- Easy to use: Prefix a function with `test_` and the test runner will execute it.
4848
No need to subclass anything.
@@ -60,7 +60,6 @@ def test_get_word_lengths():
6060
assert get_word_lengths(text) == [5, 8, 3, 7, 4, 3, 6]
6161
```
6262

63-
- [Example output](https://travis-ci.org/bast/pytest-demo/builds/104182942)
6463
- [Example project](https://github.com/bast/pytest-demo)
6564

6665
---
@@ -185,9 +184,6 @@ TEST_CASE("Use the example library to add numbers", "[add]") {
185184
}
186185
```
187186
188-
- [Example output](https://github.com/ENCCS/catch2-demo/runs/1959590399?check_suite_focus=true)
189-
- [Example project](https://github.com/ENCCS/catch2-demo)
190-
191187
---
192188
193189
(google-test)=
@@ -212,7 +208,6 @@ TEST(example, add) {
212208
}
213209
```
214210

215-
- [Example output](https://travis-ci.org/bast/gtest-demo/builds/104190982)
216211
- [Example project](https://github.com/bast/gtest-demo)
217212

218213
---
@@ -238,9 +233,6 @@ BOOST_AUTO_TEST_CASE( add )
238233
}
239234
```
240235
241-
- [Example output](https://github.com/ENCCS/boost-test-demo/runs/1959592305?check_suite_focus=true)
242-
- [Example project](https://github.com/ENCCS/boost-test-demo)
243-
244236
---
245237
246238
(pfunit)=
@@ -282,7 +274,6 @@ You can then compile using this script:
282274
:language: bash
283275
```
284276

285-
- [Example output](https://travis-ci.org/bast/pfunit-demo/builds/104193675)
286277
- [Example project](https://github.com/bast/pfunit-demo)
287278

288279
---
@@ -293,9 +284,9 @@ Each of these are web services to handle testing, free for open source
293284
projects.
294285

295286
- [GitHub Actions](https://github.com/features/actions) (we will
296-
demonstrate in next episode)
287+
demonstrate this in the next episode)
297288
- [GitLab CI](https://about.gitlab.com/features/gitlab-ci-cd/)
298-
(we will demonstrate in next episode)
289+
(we will demonstrate this in the next episode)
299290
- [Azure Pipelines](https://azure.microsoft.com/en-us/services/devops/pipelines/)
300291
- [Coveralls](https://coveralls.io)
301292
- [Codecov](https://codecov.io)
@@ -305,7 +296,6 @@ projects.
305296
## Good resources
306297

307298
- [Getting Started With Testing in Python](https://realpython.com/python-testing/)
308-
- [Introductions to Python Testing Frameworks](http://pythontesting.net/start-here/)
309299

310300

311301
```{keypoints}

0 commit comments

Comments
 (0)