-
Integers, Floats and Strings 3
-
Variables IntroductionLecture1.1
-
String FunctionalityLecture1.2
-
More FunctionalityLecture1.3
-
-
If Statements 3
-
Boolean ValuesLecture2.1
-
If StatementsLecture2.2
-
Advanced If StatementsLecture2.3
-
-
Lists, Sets and Tuples 5
-
ListsLecture3.1
-
IndexingLecture3.2
-
More IndexingLecture3.3
-
Advanced List FunctionsLecture3.4
-
SetsLecture3.5
-
-
Loops 3
-
Looping over a RangeLecture4.1
-
More List FunctionalityLecture4.2
-
While LoopLecture4.3
-
-
Functions 3
-
Basic FunctionsLecture5.1
-
Advanced FunctionsLecture5.2
-
Advanced Functions Part 2Lecture5.3
-
-
Dictionaries 3
-
Basic DictionariesLecture6.1
-
Dictionary FunctionsLecture6.2
-
Dictionary Functions 2Lecture6.3
-
-
Assertions 2
-
IntroductionLecture7.1
-
Assertions and DocstringsLecture7.2
-
-
Classes 3
-
Basic ClassesLecture8.1
-
Advanced ClassesLecture8.2
-
InheritanceLecture8.3
-
-
Matplotlib 2
-
PlottingLecture9.1
-
Plotting Part 2Lecture9.2
-
Assertions and Docstrings
Docstrings¶
Docstrings define the function and the inputs and are very useful if you want to understand what something is doing. If you use the question mark followed by the function it will show you the docstring. For example, let’s see what the max function has.
In [8]:
#If you use the ? command you can see the docstring of a function, for example let's look at the max function
? max
We can define our docstring with an explanation of the function as well as any arguments like below and use the assertion to make sure everything makes sense.
In [9]:
#Docstrings define the function and the inputs, and are done with triple quotes at the beginning of a function
def add(a, b):
"""This functions adds a and b together.
Args:
a (int): The first number.
b (int): The second number.
"""
assert type(a)==int and type(b)==int, "Arguments must be integers"
return a+b
add(1, 2)
Out[9]:
3
Now if use a question mark followed by the function then we get back that docstring.
In [10]:
? add
Prev
Introduction
Next
Basic Classes