First Review Changes - Part 2

[Robadob]

• index.md
  • Replace/remove badge (removed, not enough capacity to sort this and it's low priority)
• optimisation-introduction.md
  • Could an applied example/exercise be created to hammer home premature optimisation? Code that goes faster but makes no sense. (This could be examples away from software development, e.g. structuring a startup so that it can scale to millions of customers before it has even one.)
  • Simple pytest exercise? e.g. cover edge cases
  • Can we explain CPython/C/Python bytecode here? It gets mentioned in the following episode with no context.
• data-structures.md
  • Feels very long now, generator functions feels weak could be removed? (also remove from intro/conclusion)
  • This section could wrap an exercise proposing some hypothetical situations, what's the appropriate data structure/algorithm?
• uptodate.md
  • is there a recommended way to update/find latest supported python version/packages?
• memory.md
  • Now that numpy comes first, may be able to build a working example for variable access
• opt-conclusion.md
  • complete keypoints
  • Refer to further reading

• Add explicit breaks (this is a carpentries standard thing)
• Trusting quality/correctness/perf of packages (not clear where this fits.)
• Optimisation first-steps (Low Hanging Fruit (aka obvious stuff) #15 )

[github-actions]

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-16

The following changes were observed in the rendered markdown documents:

 index.md                        |  4 ++++
 md5sum.txt                      |  8 ++++----
 optimisation-conclusion.md      | 20 +++++++++++++++++++-
 optimisation-introduction.md    | 13 +++++++------
 optimisation-minimise-python.md |  2 +-
 5 files changed, 35 insertions(+), 12 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 2024-02-13 13:32:04 +0000