Skip to content

Minor fixes to Chapter 1#15

Merged
connoraird merged 5 commits intomainfrom
ch1-fixes
Jul 7, 2025
Merged

Minor fixes to Chapter 1#15
connoraird merged 5 commits intomainfrom
ch1-fixes

Conversation

@dpshelio
Copy link
Member

@dpshelio dpshelio commented Jul 4, 2025

Besides those small fixes, I wonder whether before challenge 2 is worth either explaining the syntax of the tests or rather convert it as pseudo-code like challenge 1.

One way to avoid either of those two steps is to fence the code that needs "attention" on the exercise (either with comments or in the readme pointing to the lines of code where the function needs to be modified), so the learners can focus their attention on the bits that matter and not in veggie syntax.

@github-actions
Copy link

github-actions bot commented Jul 4, 2025

Thank you!

Thank you for your pull request 😃

🤖 This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}.

If you have files that automatically render output (e.g. R Markdown), then you should check for the following:

  • 🎯 correct output
  • 🖼️ correct figures
  • ❓ new warnings
  • ‼️ new errors

Rendered Changes

🔍 Inspect the changes: https://github.com/UCL-ARC/fortran-unit-testing-lesson/compare/md-outputs..md-outputs-PR-15

The following changes were observed in the rendered markdown documents:

 1-intro-to-unit-tests.md | 31 +++++++++++++++++--------------
 md5sum.txt               |  2 +-
 2 files changed, 18 insertions(+), 15 deletions(-)
What does this mean?

If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible.

This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation.

⏱️ Updated at 2025-07-07 13:30:01 +0000

github-actions bot pushed a commit that referenced this pull request Jul 4, 2025
@dpshelio dpshelio requested review from connoraird and Copilot and removed request for Copilot July 4, 2025 13:55
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR applies minor fixes to Chapter 1 of the unit-testing tutorial, improving formatting, spelling, and link references.

  • Reformatted blockquote and added a proper citation link
  • Standardized pseudo-code syntax and fixed a spelling mistake
  • Corrected repository paths for Challenge 2 links
Comments suppressed due to low confidence (2)

episodes/1-intro-to-unit-tests.md:123

  • The path segment 1-into-to-unit-tests appears to be a typo; it should match the directory name 1-intro-to-unit-tests.
Take a look at [1-into-to-unit-tests/challenge-2](https://github.com/UCL-ARC/fortran-unit-testing-exercises/tree/main/episodes/1-into-to-unit-tests/challenge-2) in the exercises repository.

episodes/1-intro-to-unit-tests.md:127

  • The path in the link uses 1-into-to-unit-tests; update it to 1-intro-to-unit-tests to avoid a broken link.
A solution is provided in [episodes/1-into-to-unit-tests/challenge-2/test/solution](https://github.com/UCL-ARC/fortran-unit-testing-exercises/tree/main/episodes/1-into-to-unit-tests/challenge-2/test/solution).

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
github-actions bot pushed a commit that referenced this pull request Jul 7, 2025
github-actions bot pushed a commit that referenced this pull request Jul 7, 2025
@connoraird connoraird merged commit d6963ee into main Jul 7, 2025
3 checks passed
github-actions bot pushed a commit that referenced this pull request Jul 7, 2025
Auto-generated via `{sandpaper}`
Source  : d6963ee
Branch  : main
Author  : Connor Aird <c.aird@ucl.ac.uk>
Time    : 2025-07-07 13:31:06 +0000
Message : Merge pull request #15 from UCL-ARC/ch1-fixes

Minor fixes to Chapter 1
github-actions bot pushed a commit that referenced this pull request Jul 7, 2025
Auto-generated via `{sandpaper}`
Source  : 306a60b
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2025-07-07 13:31:54 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : d6963ee
Branch  : main
Author  : Connor Aird <c.aird@ucl.ac.uk>
Time    : 2025-07-07 13:31:06 +0000
Message : Merge pull request #15 from UCL-ARC/ch1-fixes

Minor fixes to Chapter 1
github-actions bot pushed a commit that referenced this pull request Jul 8, 2025
Auto-generated via `{sandpaper}`
Source  : 306a60b
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2025-07-07 13:31:54 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : d6963ee
Branch  : main
Author  : Connor Aird <c.aird@ucl.ac.uk>
Time    : 2025-07-07 13:31:06 +0000
Message : Merge pull request #15 from UCL-ARC/ch1-fixes

Minor fixes to Chapter 1
github-actions bot pushed a commit that referenced this pull request Jul 15, 2025
Auto-generated via `{sandpaper}`
Source  : 306a60b
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2025-07-07 13:31:54 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : d6963ee
Branch  : main
Author  : Connor Aird <c.aird@ucl.ac.uk>
Time    : 2025-07-07 13:31:06 +0000
Message : Merge pull request #15 from UCL-ARC/ch1-fixes

Minor fixes to Chapter 1
github-actions bot pushed a commit that referenced this pull request Jul 22, 2025
Auto-generated via `{sandpaper}`
Source  : 306a60b
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2025-07-07 13:31:54 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : d6963ee
Branch  : main
Author  : Connor Aird <c.aird@ucl.ac.uk>
Time    : 2025-07-07 13:31:06 +0000
Message : Merge pull request #15 from UCL-ARC/ch1-fixes

Minor fixes to Chapter 1
github-actions bot pushed a commit that referenced this pull request Jul 29, 2025
Auto-generated via `{sandpaper}`
Source  : 306a60b
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2025-07-07 13:31:54 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : d6963ee
Branch  : main
Author  : Connor Aird <c.aird@ucl.ac.uk>
Time    : 2025-07-07 13:31:06 +0000
Message : Merge pull request #15 from UCL-ARC/ch1-fixes

Minor fixes to Chapter 1
@connoraird connoraird deleted the ch1-fixes branch November 14, 2025 16:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants