differences for PR #101

06-documenting-code.md

@@ -726,8 +726,9 @@ We recommend the following resources for some additional reading on the topic of
   a high-quality README
 - [What are best practices for research software documentation?][ssi-blog-docs] (Software Sustainability blog post) by Stephan Druskat et al.
 - [Preparing Software for Reuse and Release episode][python-irsd-reuse-and-release] from the Intermediate Research Software Development lesson on The Carpentries Incubator by Aleksandra Nenadic et al.
-- [How to document your research software][coderefinery-documentation] Coderefinery lesson
-
+- [CodeRefinery lesson: How to document your research software][coderefinery-documentation]
+- [CITATION.cff file format][cff]
+
 Also check the [full reference set](learners/reference.md#litref) for the course.
 
 

links.md

@@ -61,7 +61,7 @@ any links that you are not going to use.
 [codecheck]: https://codecheck.org.uk/project/
 [python-201-documentation]: https://python-tutorial.dev/201/tutorial/documentation.html
 [python-irsd-reuse-and-release]: https://carpentries-incubator.github.io/python-intermediate-development/42-software-reuse/index.html
-[coderefinery-documenting]:https://coderefinery.github.io/documentation/
+[coderefinery-documentation]:https://coderefinery.github.io/documentation/
 [grch-documenting]: https://goodresearch.dev/docs
 [art-of-readme]: https://github.com/hackergrrl/art-of-readme#bonus-the-readme-checklist
 [realpython-mkdocs]: https://realpython.com/python-project-documentation-with-mkdocs/
@@ -97,4 +97,5 @@ any links that you are not going to use.
 [codegen]: https://www.codegen.com/
 [ai-pair-programmers]: https://www.codium.ai/glossary/pair-programming/#:~:text=Ethics%20in%20AI%20Pair%20Programming
 [ethics-ucl]: https://www.ucl.ac.uk/research-ethics/sites/research_ethics/files/research_using_apps_guidance_1.2.docx
-[ethics-software]: https://medium.com/@zoyajahidshaikh/ethical-considerations-in-software-development-e1e4ebad2670
+[ethics-software]: https://medium.com/@zoyajahidshaikh/ethical-considerations-in-software-development-e1e4ebad2670
+[cff]: https://citation-file-format.github.io/

md5sum.txt

@@ -4,14 +4,14 @@
 "LICENSE.md" "b24ebbb41b14ca25cf6b8216dda83e5f" "site/built/LICENSE.md" "2023-10-03"
 "config.yaml" "5f9816144240a9af03927c9d83fb43eb" "site/built/config.yaml" "2024-06-14"
 "index.md" "51e99c2a5d128ea62110fe0c7f0dddb6" "site/built/index.md" "2024-06-30"
-"links.md" "01d2a2b44de6bd58a9338241fb533229" "site/built/links.md" "2024-06-30"
+"links.md" "6e232c63987e4d315ebdd3316ea62bc4" "site/built/links.md" "2024-07-01"
 "episodes/00-introduction.md" "5ad6ec9b0ec53ca6e861ee719782bca4" "site/built/00-introduction.md" "2024-07-01"
 "episodes/01-fair-research-software.md" "b6e60011c17543d5d6e71b2fa3807fe6" "site/built/01-fair-research-software.md" "2024-06-30"
 "episodes/02-tools.md" "f581fb69dbfa590451c69047a657a786" "site/built/02-tools.md" "2024-07-01"
 "episodes/03-version-control.md" "5639e7d1f1c7d0e6632b809893fe5606" "site/built/03-version-control.md" "2024-06-30"
 "episodes/04-code-readability.md" "82154f520eda5d38086dbc285dcaf1e2" "site/built/04-code-readability.md" "2024-06-30"
 "episodes/05-code-testing.md" "9030741d2a9f908a1340153c542ddf14" "site/built/05-code-testing.md" "2024-06-30"
-"episodes/06-documenting-code.md" "0d5bf571f1dc0b48da89ade3a2a4af23" "site/built/06-documenting-code.md" "2024-06-30"
+"episodes/06-documenting-code.md" "2bfbeec5dcad75d122eb3236a42c1043" "site/built/06-documenting-code.md" "2024-07-01"
 "episodes/07-open-collaboration.md" "04ed233c750a42299b60e0057bbbc476" "site/built/07-open-collaboration.md" "2024-06-30"
 "episodes/08-code-ethics.md" "3520ea9de8d82b5925f2b424f0ed5ce3" "site/built/08-code-ethics.md" "2024-06-30"
 "episodes/09-wrap-up.md" "e0334370460adfbb7be9b5d3bf4d319f" "site/built/09-wrap-up.md" "2024-06-25"