Skip to content

ICR RSE: Improvements and Text Simplifications - #73

Merged
JostMigenda merged 1 commit into
mainfrom
icr-rse-manual-merge
Mar 24, 2025
Merged

JostMigenda merged 1 commit into
mainfrom
icr-rse-manual-merge

Conversation

@Robadob

@Robadob Robadob commented Mar 21, 2025 •

Copy link
Copy Markdown
Member

Manual merge of the appropriate changes from #51 (cc @msarkis-icr), mostly typographic/simplification changes (those in profiling are mostly directly used, whereas optimisation was heavily conflicted) including a new figure what I've reproduced.

Todo:

  • New figure probably needs a bit more iteration (cc @JostMigenda for feedback)
  • How should https://github.com/ICR-RSE-Group be added to learners/acknowledgements.md (cc @msarkis-icr)
    • e.g. "Members of The Institute of Cancer Research RSE contributed a large number of typographic corrections and simplifications during the alpha phase of the course's development lifecycle."
    • Happy to also name/tag specific people if preferred.
    • Manual merge has stolen all of your names from git history, if you're keen to rewrite history to change that and submit a new PR go for it (but probably wait for Jost to review the new figure).
  • Write a proper commit message
  • Fixup all the correction commits.

Closes #51

@Robadob
Robadob requested a review from JostMigenda March 21, 2025 13:45
@Robadob Robadob self-assigned this Mar 21, 2025
@github-actions

github-actions Bot commented Mar 21, 2025 •

Copy link
Copy Markdown

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/RSE-Sheffield/pando-python/compare/md-outputs..md-outputs-PR-73

The following changes were observed in the rendered markdown documents:

 acknowledgements.md                        |    2 +
 fig/list-append.ai (new)                   | 1827 ++++++++++++++++++++++++++++
 fig/list-append.png (new)                  |  Bin 0 -> 42183 bytes
 index.md                                   |    4 +-
 md5sum.txt                                 |   22 +-
 optimisation-data-structures-algorithms.md |   25 +-
 optimisation-introduction.md               |   32 +-
 optimisation-memory.md                     |    2 -
 optimisation-numpy.md                      |   19 +-
 optimisation-using-python.md               |   12 +-
 profiling-functions.md                     |   18 +-
 profiling-introduction.md                  |   14 +-
 profiling-lines.md                         |   10 +-
 setup.md                                   |   16 +-
 14 files changed, 1915 insertions(+), 88 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-03-24 12:42:42 +0000

github-actions Bot pushed a commit that referenced this pull request Mar 21, 2025
@Robadob
Robadob force-pushed the icr-rse-manual-merge branch from 888f4bb to 57dbdaa Compare March 21, 2025 15:12
github-actions Bot pushed a commit that referenced this pull request Mar 21, 2025
Comment thread episodes/fig/list-append.png Resolved
Comment thread episodes/optimisation-introduction.md Resolved
Comment thread episodes/optimisation-numpy.md Resolved
Comment thread episodes/optimisation-numpy.md Resolved
Comment thread episodes/profiling-introduction.md Resolved
Comment thread learners/setup.md Resolved
@Robadob

Robadob commented Mar 21, 2025

Copy link
Copy Markdown
Member Author

Thanks @JostMigenda for the quick feedback, I'll get this fixed up over the weekend.

github-actions Bot pushed a commit that referenced this pull request Mar 23, 2025
github-actions Bot pushed a commit that referenced this pull request Mar 23, 2025
github-actions Bot pushed a commit that referenced this pull request Mar 23, 2025
@Robadob
Robadob requested a review from JostMigenda March 23, 2025 16:41
@Robadob

Robadob commented Mar 23, 2025

Copy link
Copy Markdown
Member Author

I've addressed these points, a few responses to clarify changes though.

Thanks again for catching out all my terrible grammar (illustrator spell-check suggested I capitalise Spare/New [in red/purple] as start of sentence following the numbers).

@msarkis-icr

Copy link
Copy Markdown
  • How should https://github.com/ICR-RSE-Group be added to learners/acknowledgements.md (cc @msarkis-icr)

    • e.g. "Members of The Institute of Cancer Research RSE contributed a large number of typographic corrections and simplifications during the alpha phase of the course's development lifecycle."
    • Happy to also name/tag specific people if preferred.
    • Manual merge has stolen all of your names from git history, if you're keen to rewrite history to change that and submit a new PR go for it (but probably wait for Jost to review the new figure).

Hello @Robadob,
We are happy to name both Anastasiia shcherbakova and myself, Mira Sarkis as contributors from ICR-RSE.

github-actions Bot pushed a commit that referenced this pull request Mar 24, 2025
github-actions Bot pushed a commit that referenced this pull request Mar 24, 2025
github-actions Bot pushed a commit that referenced this pull request Mar 24, 2025
github-actions Bot pushed a commit that referenced this pull request Mar 24, 2025
@Robadob

Robadob commented Mar 24, 2025 •

Copy link
Copy Markdown
Member Author

@JostMigenda

Changes

  • Figure, Removed the 1 New/Spare caps that I previously added
  • Figure, Changed elements from the form $1$ to $P_1$
  • Figure alt text, updated text to match elements (not mentioning pointers)
  • Intro, added back a note that advanced optimisations are outside the scope of the course.

Pending

  • Figure alt-text, use AI suggested alt text it's less unwieldy than what I drafted?
  • conda python version, specify 3.13/3.11 or none (which should default latest)

@Robadob
Robadob marked this pull request as ready for review March 24, 2025 12:09
Comment thread episodes/optimisation-introduction.md Resolved
Including an additional figure that was reproduced to improve the accessibility of the font used.

This is a manual merge of approriate changes from PR (#51) due to large conflicts with earlier merged optimisation PRs.

With thanks to the original authors of these changes @msarkis-icr and @stacyrse
@Robadob
Robadob force-pushed the icr-rse-manual-merge branch from 5b88613 to 472ba9b Compare March 24, 2025 12:41
github-actions Bot pushed a commit that referenced this pull request Mar 24, 2025
@JostMigenda
JostMigenda merged commit f8e9b79 into main Mar 24, 2025
@Robadob
Robadob deleted the icr-rse-manual-merge branch March 24, 2025 12:44
github-actions Bot pushed a commit that referenced this pull request Mar 24, 2025
Auto-generated via `{sandpaper}`
Source  : f8e9b79
Branch  : main
Author  : Robert Chisholm <robert.chisholm@sheffield.ac.uk>
Time    : 2025-03-24 12:43:59 +0000
Message : Text simplification and typographic improvements via @ICR-RSE-Group (#73)

Including an additional figure that was reproduced to improve the accessibility of the font used.

This is a manual merge of approriate changes from PR (#51) due to large conflicts with earlier merged optimisation PRs.

With thanks to the original authors of these changes @msarkis-icr and @stacyrse
@Robadob

Robadob commented Mar 24, 2025

Copy link
Copy Markdown
Member Author

Thanks, next I'll try and sort out the technical appendix (probably tail end of this week).

github-actions Bot pushed a commit that referenced this pull request Mar 24, 2025
Auto-generated via `{sandpaper}`
Source  : cb617f4
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2025-03-24 12:44:46 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : f8e9b79
Branch  : main
Author  : Robert Chisholm <robert.chisholm@sheffield.ac.uk>
Time    : 2025-03-24 12:43:59 +0000
Message : Text simplification and typographic improvements via @ICR-RSE-Group (#73)

Including an additional figure that was reproduced to improve the accessibility of the font used.

This is a manual merge of approriate changes from PR (#51) due to large conflicts with earlier merged optimisation PRs.

With thanks to the original authors of these changes @msarkis-icr and @stacyrse
github-actions Bot pushed a commit that referenced this pull request Mar 25, 2025
Auto-generated via `{sandpaper}`
Source  : cb617f4
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2025-03-24 12:44:46 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : f8e9b79
Branch  : main
Author  : Robert Chisholm <robert.chisholm@sheffield.ac.uk>
Time    : 2025-03-24 12:43:59 +0000
Message : Text simplification and typographic improvements via @ICR-RSE-Group (#73)

Including an additional figure that was reproduced to improve the accessibility of the font used.

This is a manual merge of approriate changes from PR (#51) due to large conflicts with earlier merged optimisation PRs.

With thanks to the original authors of these changes @msarkis-icr and @stacyrse
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