Voici quelques exemples d'échantillons Python PEP (Python Amélioration de Python) Nous avons d'abord choisi la version d'aller avec comme cet échantillon est le plus semblable à Pep-8. Nous devons donc fournir la description de la fonction, le parm et le type de retour ...
def sample_fun(n):
"""Calculate the square root of a number.
Args:
n: the number to get the square root of.
Returns:
the square root of n.
Raises:
TypeError: if n is not a number.
ValueError: if n is negative.
"""
pass
"La liste des questions" / "sondages" ne sont pas sur le sujet du débordement de pile. En outre, je ne vois pas comment cela se rapporte à un vrai problème que vous essayez de résoudre.
J'apprécie les recherches que vous avez faites et certains exemples pourraient être trouvés du format de docstring officiel, mais il n'est pas vraiment clair que le bénéfice fournirait. Il existe des exemples de doctorats incorrects, certains d'entre eux peuvent-être même écrit par Guido. Si vous voulez écrire corrects, suivez simplement les directives (le Doc PEP lui-même donne même des exemples). En bref, quel est le point ici? Pourquoi avez-vous besoin exactement de (plus) exemples de ce formatage?
@AgF: Ce n'était pas conçu comme un sondage. Je crois que le PEP n'est pas clair à 100% sur certaines zones et je recherche des exemples qui clarifient ces parties. Plus précisément, je me loks pour un exemple de doctorats pour une classe qui correspond à la PPE. Le code de Halst montre des lignes vierges avant et après la doctorante de la classe ainsi qu'une ligne vide à la fin de la doctrine elle-même. C'est une autre option que je n'avais même pas envisagée.
@ Iulius-Caesar: Une question plus spécifique est peut-être une question plus spécifique "une ligne vierge avant et après toutes les doctossstrings". Est-ce avant ou après les citations d'ouverture / clôture?
@Bram: Je pense que l'ajout de détails comme celle-ci pourrait aider cette question à obtenir des réponses utiles.