Google#
Style Google#
Rien n’empêche d’écrire les docs en français, mais il est préférable de les écrire en anglais, afin de respecter les conventions de la pep8.
⚙️ Google
1def addition(a, b):
2 """
3 This function takes two numbers as input and returns their sum.
4
5 Args:
6 a (int): The first number.
7 b (int): The second number.
8
9 Returns:
10 int: The sum of the two numbers.
11 """
12 return a + b
Pour affcicher la docstring d’une fonction, classe ou méthode, il est suffit d’écrire le nom de celle-ci, suivi de .__doc__.
print(addition.__doc__)
This function takes two numbers as input and returns their sum.
Args:
a (int): The first number.
b (int): The second number.
Returns:
int: The sum of the two numbers.