From 7524827bc48ba237e646b0e9557f9c8d3a276d4d Mon Sep 17 00:00:00 2001 From: DaniBodor Date: Tue, 5 Nov 2024 13:07:39 +0100 Subject: [PATCH 1/2] typos and minor changes --- modules/citation/slides-citation.md | 2 +- modules/distributing/slides-distributing.md | 2 +- modules/licenses/ex_finding_the_license.md | 3 ++- modules/publication/slides-publication.md | 4 ++++ modules/testing/slides.md | 4 ++-- 5 files changed, 10 insertions(+), 5 deletions(-) diff --git a/modules/citation/slides-citation.md b/modules/citation/slides-citation.md index ece4dc18..83b41c35 100644 --- a/modules/citation/slides-citation.md +++ b/modules/citation/slides-citation.md @@ -63,7 +63,7 @@ Note: ## What software to cite? -*""...the software itself should be cited on the same basis as any other research product; authors should cite the appropriate set of software products."* +*"...the software itself should be cited on the same basis as any other research product; authors should cite the appropriate set of software products."* Which software would you cite? diff --git a/modules/distributing/slides-distributing.md b/modules/distributing/slides-distributing.md index cfb3321e..4b62a79d 100644 --- a/modules/distributing/slides-distributing.md +++ b/modules/distributing/slides-distributing.md @@ -108,4 +108,4 @@ Specify the dependencies in a file and let the user build their own environment, - If other software might depend on this software, package it - To archive a specific software version and its environment, you could use a container -=== \ No newline at end of file +=== diff --git a/modules/licenses/ex_finding_the_license.md b/modules/licenses/ex_finding_the_license.md index 1e847291..20f2738e 100644 --- a/modules/licenses/ex_finding_the_license.md +++ b/modules/licenses/ex_finding_the_license.md @@ -1,5 +1,5 @@ --- -title: Finding the license +title: Find the license type: exercise order: 3 --- @@ -23,3 +23,4 @@ A few hints: - The researcher only gave you the name. You'll have to find the code on the Internet first. - Licenses are not always advertised on a code's website. Try looking somewhere more technical if you can't find it in the documentation. +## Exercise 2: What advice would you give? diff --git a/modules/publication/slides-publication.md b/modules/publication/slides-publication.md index f070b94c..f2a1c553 100644 --- a/modules/publication/slides-publication.md +++ b/modules/publication/slides-publication.md @@ -69,6 +69,10 @@ Reusability - it's only reusable if it's available, and if people know what they * Write a paper about those results * Possibly not even mentioning the software at all +=== + + + ### Consequences * The software itself is not citable diff --git a/modules/testing/slides.md b/modules/testing/slides.md index bbaddd30..a72ccded 100644 --- a/modules/testing/slides.md +++ b/modules/testing/slides.md @@ -32,7 +32,7 @@ Untested software can be compared to uncalibrated experimental devices. -## Risks of untested research software +## Risks of poorly tested (research) software
@@ -59,7 +59,7 @@ There is also the case of the Ariane flight V88, an European Space Agency rocket -## Why testing your software ? +## Why test your software ? - Ensure software reliability, validity, and reproducibility. - Confirm correct installation and demonstrate use. From 3ddc160b15692623aca2841511bfbf270bac5d05 Mon Sep 17 00:00:00 2001 From: Jaro Camphuijsen Date: Wed, 6 Nov 2024 11:44:17 +0100 Subject: [PATCH 2/2] Update modules/distributing/slides-distributing.md --- modules/distributing/slides-distributing.md | 1 - 1 file changed, 1 deletion(-) diff --git a/modules/distributing/slides-distributing.md b/modules/distributing/slides-distributing.md index 4b62a79d..bbed067d 100644 --- a/modules/distributing/slides-distributing.md +++ b/modules/distributing/slides-distributing.md @@ -108,4 +108,3 @@ Specify the dependencies in a file and let the user build their own environment, - If other software might depend on this software, package it - To archive a specific software version and its environment, you could use a container -===