Skip to content

More small fixes#155

Merged
alexdewar merged 5 commits intomainfrom
more-fixes
Feb 3, 2026
Merged

More small fixes#155
alexdewar merged 5 commits intomainfrom
more-fixes

Conversation

@alexdewar
Copy link
Copy Markdown

@alexdewar alexdewar commented Jan 30, 2026

Here are fixes for a few more small issues that I noticed while delivering the course.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Jan 30, 2026

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/ImperialCollegeLondon/rse_further_git_course/compare/md-outputs..md-outputs-PR-155

The following changes were observed in the rendered markdown documents:

 04-rewriting_history.md      | 4 ++--
 07-managing_contributions.md | 2 +-
 08-continuous_integration.md | 4 ++--
 md5sum.txt                   | 6 +++---
 4 files changed, 8 insertions(+), 8 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 2026-01-30 16:05:40 +0000

@alexdewar alexdewar requested a review from Copilot January 30, 2026 15:44
github-actions bot pushed a commit that referenced this pull request Jan 30, 2026
Copy link
Copy Markdown

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 addresses several small documentation fixes discovered during course delivery, improving markdown formatting, indentation, and text accuracy across multiple episode files.

Changes:

  • Fixed markdown code formatting for GitHub Actions trigger names
  • Corrected list item indentation for better readability
  • Fixed incorrect block type label from "objectives" to "discussion"
  • Corrected spelling error from "you" to "your"

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
episodes/08-continuous_integration.md Improved markdown code formatting for trigger names and fixed list item indentation
episodes/07-managing_contributions.md Corrected block type label from "objectives" to "discussion"
episodes/04-rewriting_history.md Fixed spelling error "you" to "your"

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
github-actions bot pushed a commit that referenced this pull request Jan 30, 2026
Copy link
Copy Markdown

@AdrianDAlessandro AdrianDAlessandro left a comment

Choose a reason for hiding this comment

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

Makes sense, one question but it's not related to this PR and shouldn't prevent merging.

Pull requests are a GitHub feature which allows collaborators tell each other about changes that have been pushed to a branch in a repository. Similar to **issues**, an open pull request can contain discussions about the requested changes and allows collaborators to review proposed amendments and follow-up commits before changes are either rejected or accepted and merged into the base branch.

:::::::::::::::::::::::::::::::::::::: objectives
:::::::::::::::::::::::::::::::::::::: discussion
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Makes sense. But I've just noticed when looking at the live version of the notes that it says "Discussion" of "Callout" as the heading for all of these sections. I would be much better if this title was the actual heading we want for these sections. Do we know if this is possible?

Copy link
Copy Markdown

@SaranjeetKaur SaranjeetKaur Feb 3, 2026

Choose a reason for hiding this comment

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

@AdrianDAlessandro from what I can tell, these different sections are created using special tags ( discussion, prereq, challenge etc.) on the respective fenced div.

The actual heading would usually go inside the fenced div, similar to how we write a heading in markdown. So something like:

:::::::::: discussion

##  Pull Requests in GitHub

Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa.

::::::::::

As an example, refer the use of challenge tag and its header in this git novice lesson by Software Carpentry.

Copy link
Copy Markdown

@SaranjeetKaur SaranjeetKaur left a comment

Choose a reason for hiding this comment

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

Thanks @alexdewar! Looks good.

@alexdewar alexdewar merged commit 022e6da into main Feb 3, 2026
4 checks passed
@alexdewar alexdewar deleted the more-fixes branch February 3, 2026 13:55
github-actions bot pushed a commit that referenced this pull request Feb 3, 2026
Auto-generated via `{sandpaper}`
Source  : 022e6da
Branch  : main
Author  : Alex Dewar <alexdewar@users.noreply.github.com>
Time    : 2026-02-03 13:55:53 +0000
Message : Merge pull request #155 from ImperialCollegeLondon/more-fixes

More small fixes
github-actions bot pushed a commit that referenced this pull request Feb 3, 2026
Auto-generated via `{sandpaper}`
Source  : d0ac474
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2026-02-03 13:56:44 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : 022e6da
Branch  : main
Author  : Alex Dewar <alexdewar@users.noreply.github.com>
Time    : 2026-02-03 13:55:53 +0000
Message : Merge pull request #155 from ImperialCollegeLondon/more-fixes

More small fixes
github-actions bot pushed a commit that referenced this pull request Feb 3, 2026
Auto-generated via `{sandpaper}`
Source  : d0ac474
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2026-02-03 13:56:44 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : 022e6da
Branch  : main
Author  : Alex Dewar <alexdewar@users.noreply.github.com>
Time    : 2026-02-03 13:55:53 +0000
Message : Merge pull request #155 from ImperialCollegeLondon/more-fixes

More small fixes
github-actions bot pushed a commit that referenced this pull request Feb 10, 2026
Auto-generated via `{sandpaper}`
Source  : d0ac474
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2026-02-03 13:56:44 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : 022e6da
Branch  : main
Author  : Alex Dewar <alexdewar@users.noreply.github.com>
Time    : 2026-02-03 13:55:53 +0000
Message : Merge pull request #155 from ImperialCollegeLondon/more-fixes

More small fixes
github-actions bot pushed a commit that referenced this pull request Feb 17, 2026
Auto-generated via `{sandpaper}`
Source  : d0ac474
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2026-02-03 13:56:44 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : 022e6da
Branch  : main
Author  : Alex Dewar <alexdewar@users.noreply.github.com>
Time    : 2026-02-03 13:55:53 +0000
Message : Merge pull request #155 from ImperialCollegeLondon/more-fixes

More small fixes
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.

4 participants