Discussion :

[Acil67]

Bien le bonjour à la communauté !

Je voudrais avoir vos avis sur les docstrings que j'ai rédigé pour les fonctions du script en pièce jointe. J'ai travaillé avec pytesseract (outil pour océrisation d'image).

Merci d'avance

[VinsS]

Salut,

S'en tenir à l'essentiel, pas de longues phrases, La première ligne donne une explication courte sur une seule ligne physique, si nécessaire une explication longue peut suivre, séparée d'une ligne vide.

Pas plus de 80 caractères par ligne.

Les arguments sont définis un par ligne et le retour éventuel vient à la fin.

Exemple:

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
 
def get_dimensions(i, image_data):
    """Retourne les dimensions du cadre selon l'indice.
 
    Args:
    i -- indice
    image_data -- dict(données picturales)
 
    Return:
    cv2.rectangle
    """
 
def save_image(img, output_file):
    """Enregistre l'image sur le disque.
 
    Args:
    img -- données de l'image
    output_file -- nom du fichier à créer
    """