diff --git a/contributors.md b/contributors.md index c44884e..a6ee404 100644 --- a/contributors.md +++ b/contributors.md @@ -54,10 +54,12 @@ On code hosting platforms such as GitHub, the contribution guide will be created :::: challenge -TODO - Create a new file called `CONTRIBUTING.md` and populate it with a few sentences. +- What are the most important things for a new contributor to know? +- What should a user do if they encounter a bug? +- What are the common questions that a new developer might have when they work on this research software? + :::: ## Software project governance diff --git a/docstrings.md b/docstrings.md index 18113ea..37a156a 100644 --- a/docstrings.md +++ b/docstrings.md @@ -129,7 +129,20 @@ Use the `help()` function to view the documentation string for a function. ::::::::::::::::: solution -TODO +Let's view the help text for an in-built [function `abs()`](https://docs.python.org/3/library/functions.html#abs) that finds the absolute value of a number. + +```python +help(abs) +``` + +The following text will be printed to the screen@ + +```output +Help on built-in function abs in module builtins: + +abs(x, /) + Return the absolute value of the argument. +``` :::::::::::::::::::::::::: diff --git a/md5sum.txt b/md5sum.txt index c5af0a6..647ada1 100644 --- a/md5sum.txt +++ b/md5sum.txt @@ -7,10 +7,10 @@ "links.md" "8184cf4149eafbf03ce8da8ff0778c14" "site/built/links.md" "2024-05-20" "episodes/introduction.md" "123579b22c95b6dcb57401b057235db5" "site/built/introduction.md" "2024-08-16" "episodes/readmes.md" "7f814493f5072a579424de3222583ebb" "site/built/readmes.md" "2024-07-22" -"episodes/docstrings.md" "28d95c6f87a20ecb3ece5010a999f8b9" "site/built/docstrings.md" "2024-08-16" +"episodes/docstrings.md" "144c97b797a8bdeafbaf8a9fae4d2099" "site/built/docstrings.md" "2024-08-16" "episodes/readable.md" "1f80fef3634faac146f4d6d324a92a3b" "site/built/readable.md" "2024-08-16" "episodes/sites.md" "65aa4c45daf0fd4749034d961dd511c6" "site/built/sites.md" "2024-06-10" -"episodes/contributors.md" "1ee5921b02ebee9da030e06f06d52d08" "site/built/contributors.md" "2024-08-05" +"episodes/contributors.md" "1e5a2cae9d5ef5fb6949ebd0abdbfb1d" "site/built/contributors.md" "2024-08-16" "episodes/cli.md" "605efa02a00db1bb673591623c31b632" "site/built/cli.md" "2024-06-21" "instructors/instructor-notes.md" "cae72b6712578d74a49fea7513099f8c" "site/built/instructor-notes.md" "2024-05-20" "learners/acknowledgements.md" "a751175e5c52ccbf05f8291162bc2cea" "site/built/acknowledgements.md" "2024-08-16"