Skip to content

Commit c5ea113

Browse files
authored
Update CITATION.cff
Fixed: Fixed me
1 parent d8e5537 commit c5ea113

1 file changed

Lines changed: 15 additions & 6 deletions

File tree

CITATION.cff

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,27 @@
55
# ensuring that the author list and other fields remain accurate.
66

77
cff-version: 1.2.0
8-
title: FIXME
8+
title: Write readable code
99
message: >-
1010
Please cite this lesson using the information in this file
1111
when you refer to it in publications, and/or if you
1212
re-use, adapt, or expand on the content in your own
1313
training material.
1414
type: dataset
1515
authors:
16-
- given-names: FIXME
17-
family-names: FIXME
16+
- given-names: Magda
17+
family-names: Guglielmo
18+
affiliation: CSIRO
19+
email: magda.guglielmo@csiro.au
1820
abstract: >-
19-
FIXME Replace this with a short abstract describing the
20-
lesson, e.g. its target audience and main intended
21-
learning objectives.
21+
This lesson introduces the importance of writing readable code, highlighting that this practice primarily benefits the author before aiding others.
22+
Participants will explore examples of basic, functional, yet unstructured code and learn to apply simple rules—such as meaningful names, effective
23+
error handling, and clear docstrings—that transform it into readable and maintainable scripts. This approach has the advantage of making code easier
24+
to understand, debug, and improve.
25+
26+
The lesson also emphasises the importance of testing and its role in making the code more reliable.
27+
By being introduced to test-driven development (TDD), learners will discover how creating tests before can lead to more robust and structured code.
28+
29+
By the end of the lesson, participants will be equipped with practical techniques to improve their coding standards.
30+
They will understand how to inspect their code critically to continuously improve its quality.
2231
license: CC-BY-4.0

0 commit comments

Comments
 (0)