Skip to content

Various minor fixes#35

Merged
JostMigenda merged 4 commits intocarpentries-incubator:mainfrom
JostMigenda:various_fixes
Feb 24, 2026
Merged

Various minor fixes#35
JostMigenda merged 4 commits intocarpentries-incubator:mainfrom
JostMigenda:various_fixes

Conversation

@JostMigenda
Copy link
Copy Markdown
Collaborator

  • replace “method” with the more generic “function”
    • There are some instances where “method” would have been correct. I have changed those as well, to avoid confusing learners when we switch back and forth between those terms, but have kept that in a separate commit in case anyone disagrees.
  • Python uses Grass.eaten instead of Grass::eaten
  • … and a couple of other minor fixes, rewordings, etc.

“method: A function which is defined inside a class body.” This is not the case for most of these functions.
https://docs.python.org/3/glossary.html#term-method
These are cases which actually refer to methods, split into their own commit
`Grass::eaten` is a C++-ism; Python uses `Grass.eaten`
@JostMigenda JostMigenda requested a review from Robadob February 23, 2026 19:30
@github-actions
Copy link
Copy Markdown

github-actions bot commented Feb 23, 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/carpentries-incubator/pando-python/compare/md-outputs..md-outputs-PR-35

The following changes were observed in the rendered markdown documents:

 files/snakeviz-worked-example/example.py |  2 +-
 md5sum.txt                               | 12 ++++----
 optimisation-introduction.md             |  2 +-
 optimisation-numpy.md                    | 17 +++++-----
 profiling-conclusion.md                  |  6 ++--
 profiling-functions.md                   | 53 +++++++++++++++++---------------
 profiling-introduction.md                |  2 +-
 profiling-lines.md                       | 38 +++++++++++------------
 8 files changed, 67 insertions(+), 65 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-02-23 19:32:35 +0000

github-actions bot pushed a commit that referenced this pull request Feb 23, 2026
Copy link
Copy Markdown
Collaborator

@Robadob Robadob left a comment

Choose a reason for hiding this comment

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

All looks good.

I think my preference for method (albeit I'm by no means consistent) stems from a teacher we had at a-levels, whining about function not being precisely correct in some circumstances. I don't recall their exact argument, but it's stuck with me.

@JostMigenda JostMigenda merged commit 98d9d41 into carpentries-incubator:main Feb 24, 2026
5 checks passed
@JostMigenda JostMigenda deleted the various_fixes branch February 24, 2026 13:11
github-actions bot pushed a commit that referenced this pull request Feb 24, 2026
Auto-generated via `{sandpaper}`
Source  : 98d9d41
Branch  : main
Author  : Jost Migenda <jost.migenda@kcl.ac.uk>
Time    : 2026-02-24 13:11:16 +0000
Message : Merge pull request #35 from JostMigenda/various_fixes

Various minor fixes
github-actions bot pushed a commit that referenced this pull request Feb 24, 2026
Auto-generated via `{sandpaper}`
Source  : 566b807
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2026-02-24 13:13:16 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : 98d9d41
Branch  : main
Author  : Jost Migenda <jost.migenda@kcl.ac.uk>
Time    : 2026-02-24 13:11:16 +0000
Message : Merge pull request #35 from JostMigenda/various_fixes

Various minor 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.

2 participants