Skip to content

Commit

Permalink
Fix pyRSE book links
Browse files Browse the repository at this point in the history
  • Loading branch information
MakisH committed Dec 10, 2024
1 parent 32dfb9a commit 9da3296
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion 00_organization/wt2122/timetable.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
- **15** [Introduction to RSE](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/00_organization/rse_basics_slides.md)
- **15** [Introduction to version control](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/01_version_control/intro_slides.md)
- **15** [Recap of Git basics](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/01_version_control/git_basics_demo.md#recap-of-git-basics)
- Tell students how to recap Git in detail if needed: [py-rse book](https://merely-useful.tech/py-rse/)
- Tell students how to recap Git in detail if needed: [py-rse book](https://third-bit.com/py-rse/)

## 1.2 – Thu, October 21, 2021

Expand Down
2 changes: 1 addition & 1 deletion 00_organization/wt2223/timetable.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
## 1.2 – Thu, October 20, 2022

- **15** [Recap of Git basics](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/01_version_control/git_basics_demo.md#recap-of-git-basics)
- Tell students how to recap Git in detail if needed: [py-rse book](https://merely-useful.tech/py-rse/)
- Tell students how to recap Git in detail if needed: [py-rse book](https://third-bit.com/py-rse/)
- **50** [How I work with Git](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/01_version_control/git_basics_demo.md#how-i-work-with-git)
- **20** [Your Challenge: Contribute to Real Simulation Software](https://github.com/Simulation-Software-Engineering/Lecture-Material/blob/main/00_organization/challenge_intro_slides.md)
- Ask students to prepare *My favorite neat little Git trick*
Expand Down
2 changes: 1 addition & 1 deletion 01_version_control/git_quiz.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Git Quiz

Questions are taken from [py-rse](https://merely-useful.tech/py-rse/index.html), [learn.co](https://learn.co/lessons/git-github-learn-quiz), [w3schools](https://www.w3schools.com/quiztest/quiztest.asp?qtest=GIT), [this gist from @aspencer8111](https://gist.github.com/aspencer8111/17a80fb0a2be7b4718237fe8caa6e09c), and [codercrunch](https://www.codercrunch.com/quiz/take/1650218502/git-branching).
Questions are taken from [py-rse](https://third-bit.com/py-rse/index.html), [learn.co](https://learn.co/lessons/git-github-learn-quiz), [w3schools](https://www.w3schools.com/quiztest/quiztest.asp?qtest=GIT), [this gist from @aspencer8111](https://gist.github.com/aspencer8111/17a80fb0a2be7b4718237fe8caa6e09c), and [codercrunch](https://www.codercrunch.com/quiz/take/1650218502/git-branching).

## Add & Commit I

Expand Down
8 changes: 4 additions & 4 deletions 04_documentation/technical_writing_slides.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,15 +156,15 @@ Much content of this lecture is taken from [Write the Docs](https://www.writethe

---

From [py-RSE](https://merely-useful.tech/py-rse/documentation.html):
From [py-RSE](https://third-bit.com/py-rse/documentation.html):

> The best function names in the world aren't going to answer the questions “Why does the software do this?” and “Why doesn’t it do this in a simpler way?”
---

## Be Clear About Your Audience (2/2)

[py-RSE](https://merely-useful.tech/py-rse/documentation.html) distinguishes novices, competent practitioners, and experts (following [Wilson 2019, Teaching Tech Together](https://doi.org/10.1201/9780429330704))
[py-RSE](https://third-bit.com/py-rse/documentation.html) distinguishes novices, competent practitioners, and experts (following [Wilson 2019, Teaching Tech Together](https://doi.org/10.1201/9780429330704))

- A **novice** doesn’t yet have a mental model of the domain. -> Needs **tutorials** that introduce key ideas one by one.
- Good example: [deal.ii tutorials](https://dealii.org/developer/doxygen/deal.II/Tutorial.html)).
Expand Down Expand Up @@ -477,8 +477,8 @@ Example: [preCICE API](https://precice.org/doxygen/main/classprecice_1_1SolverIn

## Further Reading

- [py-rse appendix on documentation](https://merely-useful.tech/py-rse/documentation.html)
- [py-rse on docstrings](https://merely-useful.tech/py-rse/scripting.html#scripting-docstrings)
- [py-rse appendix on documentation](https://third-bit.com/py-rse/documentation.html)
- [py-rse on docstrings](https://third-bit.com/py-rse/scripting.html#scripting-docstrings)
- [Write the Docs](https://www.writethedocs.org/)
- [I'd Rather Be Writing blog](https://idratherbewriting.com/)
- [Google developer documentation style guide](https://developers.google.com/style)
Expand Down
2 changes: 1 addition & 1 deletion 04_documentation/website_generators_slides.md
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ From [project homepage](https://readthedocs.org/)
- [Sphinx homepage](https://www.sphinx-doc.org/en/master/)
- [Sphinx tutorial](https://www.sphinx-doc.org/en/master/tutorial/index.html)
- [Sphinx autodoc extension](https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html)
- [py-RSE: Packaging with Sphinx](https://merely-useful.tech/py-rse/packaging.html#packaging-sphinx)
- [py-RSE: Packaging with Sphinx](https://third-bit.com/py-rse/packaging.html#packaging-sphinx)
- [Doxygen](https://www.doxygen.nl/)
- [MkDocs](https://www.mkdocs.org)
- [Read the Docs](https://readthedocs.org/)
Expand Down

0 comments on commit 9da3296

Please sign in to comment.