Skip to content

Commit 5ac731f

Browse files
authored
Merge pull request #462 from hsaunders1904/458_fix_discrepancy_in_git_instructions
Correct links and a typo in slides of section 3/4
2 parents f4b4ef2 + 6eef578 commit 5ac731f

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

learners/common-issues.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ Git Bash uses its own SSH library by default, which may result in errors such as
143143
even after adding your SSH key correctly:
144144

145145
```
146-
$ git clone [email protected]:ukaea-rse-training/python-intermediate-inflammation
146+
$ git clone [email protected]:carpentries-incubator/python-intermediate-inflammation.git
147147
Cloning into 'python-intermediate-inflammation'...
148148
[email protected]: Permission denied (publickey).
149149
fatal: Could not read from remote repository.

slides/section_4_collaborative_soft_dev.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ jupyter:
2323
- up until this point, the course has been primarily focussed on technical practices, tools, and infrastructure, and primarily from the perspective of a single developer/researcher, albeit within a team environment
2424
- in this section, we are going to start broadening our attention to the collaborative side of software development
2525
- there are primarily two practices that facilitate collaboration: code review and package release
26-
- code review has many benefits, but top among them is that it provides a gate check on software quality,
26+
- code review has many benefits, but top among them is that it provides a gate check on software quality,
2727
- it is also a way to share knowledge within a team, improving the redundancy of that team (which is actually a good thing regardless of what corporate types might say!)
2828
- getting another set of eyes on your code also means you are less likely to flout coding standards and convention
2929
- there are many different types of code review, and we will explore the most common in this section
@@ -46,7 +46,7 @@ git branch --all
4646
If not, please run these commands:
4747

4848
```bash
49-
git remote add upstream [email protected]:ukaea-rse-training/python-intermediate-inflammation.git
49+
git remote add upstream [email protected]:carpentries-incubator/python-intermediate-inflammation.git
5050
git fetch upstream
5151
git checkout upstream/feature-std-dev
5252
git switch --create feature-std-dev
@@ -204,20 +204,20 @@ Follow the instructions under this exercise heading. Read the content above the
204204
<!-- #endregion -->
205205

206206
<!-- #region slideshow={"slide_type": "subslide"} -->
207-
- 🔁 We want our code to be somewhere on the "reusablility" spectrum
207+
- 🔁 We want our code to be somewhere on the "reusability" spectrum
208208
- 📝 Documentation is an important part of our code being reusable
209209
<!-- #endregion -->
210210

211211
<!-- #region slideshow={"slide_type": "notes"} -->
212-
- We want our code to be somewhere on the "reusablility" spectrum
212+
- We want our code to be somewhere on the "reusability" spectrum
213213
- but where exactly? this will depend on the maturity of your code and how widely it will be used (similar to testing)
214214
- at a minimum, we want to aim for reproducibility if we are publishing: someone else should be able to take our code and data and run it themselves and get the same result
215215
- however, for big library packages, we probably want to bump that up to reusable, where our code is easy to use, understand, and modify
216216
- Documentation is an important part of our code being reusable
217217
- Even if you write incredibly expressive code, it will not be enough for someone new to start using and modifying your code base
218218
- How do they install it? Are there any development tools they need? What is the scientific context and limitations of the code?
219219
- We need to answer all of these questions and more if we want our code to be approachable and reusable
220-
220+
221221
TODO would be nice to modify the image from <https://the-turing-way.netlify.app/_images/reproducible-definition-grid.svg> so that it better reflects the ACM definition of reproducibility/replicability
222222
<!-- #endregion -->
223223

0 commit comments

Comments
 (0)