Skip to content

Update docstring guidelines #64

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
simongrossi merged 1 commit into from
Jun 11, 2025
Merged

Update docstring guidelines #64

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,10 @@ Merci de votre intérêt pour contribuer à Anonyfiles !
- Utilisez Black pour formater le code Python.
- Suivez la structure de fichiers du projet.

### Docstrings
Les docstrings doivent suivre le format **Google**. Ce style simplifie
l'automatisation de la documentation et assure une présentation cohérente.
### Format des docstrings (style Google)
Nous utilisons le **style Google** pour toutes les docstrings. Ce format facilite
la génération automatique de la documentation et assure une présentation
cohérente dans l'ensemble du projet. Voici un exemple minimal :

```python
def saluer(nom: str) -> str:
Expand All @@ -31,7 +32,7 @@ def saluer(nom: str) -> str:
nom: Nom de la personne à saluer.

Returns:
La chaîne de caractères du message.
str: Le message final.
"""
return f"Bonjour {nom}!"
```
Expand Down
Loading