Skip to content

Commit b600d84

Browse files
authored
Improve CITATION.cff (#77)
* Improve CITATION.cff See https://carpentries.github.io/sandpaper-docs/editing.html#creating-a-cff-for-a-lesson * Resolve uninformative link text * Performance of Python should be at the same level as premature optimisation.
1 parent f8e9b79 commit b600d84

File tree

3 files changed

+13
-4
lines changed

3 files changed

+13
-4
lines changed

CITATION.cff

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,17 @@
33

44
cff-version: 1.2.0
55
title: Performance Profiling & Optimisation (Python)
6-
message: Please cite this course using these metadata.
7-
type: software
6+
message: >-
7+
Please cite this lesson using the information in this file
8+
when you refer to it in publications, and/or if you
9+
re-use, adapt, or expand on the content in your own
10+
training material. To cite the Workbench software itself,
11+
please refer to the websites for the individual
12+
components:
13+
https://carpentries.github.io/sandpaper/authors.html#citation,
14+
https://carpentries.github.io/pegboard/authors.html#citation,
15+
https://carpentries.github.io/varnish/authors.html#citation
16+
type: dataset
817
authors:
918
- given-names: Robert
1019
family-names: Chisholm

episodes/optimisation-introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Profiling is a valuable tool for prioritising optimisations. Should effort be ex
4747

4848
This doesn't mean you should ignore performance when initially writing code. Choosing the right algorithms and data structures, as we will discuss in this course, is good practice. However, there's no need to obsess over micro-optimising every tiny component of your code—focus on the bigger picture.
4949

50-
### Performance of Python
50+
## Performance of Python
5151

5252
If you've read about different programming languages, you may have heard that there’s a difference between "interpreted" languages (like Python) and "compiled" languages (like C). You may have heard that Python is slow *because* it is an interpreted language.
5353
To understand where this comes from (and how to get around it), let's talk a little bit about how Python works.

learners/ppp.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@ The 25 minute talk, which introduces many of the Python patterns from the Optimi
1414

1515
The talk has an accompanying Jupyter notebook, allowing people to benchmark the patterns on their own hardware.
1616

17-
The notebook can be downloaded [here](https://drive.google.com/file/d/1YTEXJlDaaZBAGo-Aodukuw0ArVJakdBB/view?usp=sharing).
17+
[Download the notebook here!](https://drive.google.com/file/d/1YTEXJlDaaZBAGo-Aodukuw0ArVJakdBB/view?usp=sharing).

0 commit comments

Comments
 (0)