Skip to content

Conversation

@Robadob
Copy link
Collaborator

@Robadob Robadob commented Nov 26, 2025

Spotted this whilst reading through materials ahead of running the course on Friday.

Spotted this whilst reading through materials ahead of running the course on Friday.
@Robadob Robadob requested a review from JostMigenda November 26, 2025 18:49
@Robadob Robadob self-assigned this Nov 26, 2025
@github-actions
Copy link

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

The following changes were observed in the rendered markdown documents:

 md5sum.txt         |  2 +-
 profiling-lines.md | 19 +------------------
 2 files changed, 2 insertions(+), 19 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-11-26 18:49:51 +0000

github-actions bot pushed a commit that referenced this pull request Nov 26, 2025
Copy link
Collaborator

@JostMigenda JostMigenda left a comment

Choose a reason for hiding this comment

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

Ah, I forgot we had that duplicated in the episode. We could probably replace the installation instructions with a link to the setup page (or remove them completely, here); I don't think we explicitly call out the pip installs elsewhere before using third-party packages?

@Robadob
Copy link
Collaborator Author

Robadob commented Nov 26, 2025

Ah, I forgot we had that duplicated in the episode. We could probably replace the installation instructions with a link to the setup page (or remove them completely, here); I don't think we explicitly call out the pip installs elsewhere before using third-party packages?

Same is done for snakeviz (as cProfile is core Python), I don't believe it's done for any of the dependencies required by exercises just the profiling tools.

https://carpentries-incubator.github.io/pando-python/profiling-functions.html#snakeviz

@Robadob Robadob merged commit fac2cca into main Nov 26, 2025
3 checks passed
@Robadob
Copy link
Collaborator Author

Robadob commented Nov 26, 2025

I assume my original logic was it's nice for the profiler episodes to be standalone if people want to refer back to them later, hence inclusion of installation instructions. Setup instructions are just to reduce stalls mid-lesson.

@Robadob Robadob deleted the fix-osx-lineprofiler-consistency branch November 26, 2025 19:55
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