S'il est donné, doc sera la docstring de l'attribut.
If given, doc will be the docstring of the property attribute.
La docstring est utilisée dans l'utilitaire d'aide fourni par l'invite de commande.
The docstring is used in the help utility provided by the shell.
Que mettre dans un docstring de module python?
Dans cet exemple, nous créons notre propre docstring et la fonction avec une instruction return
In this example, we create our own docstring and function with a return statement
La première déclaration d'une fonction peut être une déclaration facultative - la chaîne de documentation de la fonction ou docstring.
The first statement of a function can be an optional statement - the documentation string of the function or docstring.
Dans les définitions de classe ou de fonction, un docstring est souvent déjà en place en tant qu'instruction obligatoire à exécuter dans le bloc.
In class or function definitions, often a docstring is already in place as the obligatory statement to be executed as the only thing in the block.
En plus de lui fournir une chaîne « docstring » utile pour les développeurs, vous pouvez également permettre aux utilisateurs de l'application d'administration de voir une courte description du type de champ via l'application django.contrib.admindocs.
In addition to providing a docstring for it, which is useful for developers, you can also allow users of the admin app to see a short description of the field type via the django.contrib.admindocs application.
La première instruction du corps de la fonction peut éventuellement être un texte dans une chaîne de caractères; cette chaîne est la chaîne de documentation de la fonction, ou docstring.
The first statement of the function body can optionally be a string literal; this string literal is the function's documentation string, or docstring.
Modifié dans la version 3.1: En 3.1, ceci a été modifié pour ajouter le nom du test à la description courte, même en présence d'une docstring.
Changed in version 3.1: In 3.1 this was changed to add the test name to the short description even in the presence of a docstring.
L'implémentation par défaut de cette méthode renvoie la première ligne de la docstring de la méthode de test, si disponible, ou None.
The default implementation of this method returns the first line of the test method's docstring, if available, or None.
Par exemple, si l'un des fichiers Python contient une chaîne « docstring » expliquant une certaine fonctionnalité liée à la production de gabarit, cela pourrait produire un exemple incorrect.
For example, if one of the Python files contains a docstring explaining a particular feature related to template rendering, it might result in an incorrect example.
docstring: Ceci est le commentairevous souhaitez donner à votre poste.
docstring: This is the comment you want to give in your extension.
Ces trois parties doivent IMPÉRATIVEMENT se suivre dans la docstring.
These three parts must be grouped together in the docstring.
