Skip to content

Commit

Permalink
Apply suggestions from @MarionBWeinzierl - links and list readme sect…
Browse files Browse the repository at this point in the history
…ion.
  • Loading branch information
jatkinson1000 committed Sep 24, 2024
1 parent de94284 commit 6f72db4
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions JOSE_paper/paper.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ More specifically we cover:

# Teaching materials

All of the teaching materials for this course are available online in a GitHub repository.
All of the teaching materials for this course are [available online in a GitHub repository](https://github.com/jatkinson1000/rse-skills-workshop).


## Slides
Expand All @@ -115,7 +115,8 @@ The slides are broken into separate files by section covering:
- Code formatting for consistent readable layout,
- Naming principles for readable, re-useable code,
- Linting and static analysis of code,
- Writing docstrings and comments, and
- Writing docstrings and comments,
- READMEs and Licenses, and
- Other general principles including magic numbers, avoiding hard-coded values, etc.

This makes it easy to remove sections to tailor the course, or for additional topics to be added in future.
Expand Down

0 comments on commit 6f72db4

Please sign in to comment.