Expliquer vos techniques
Le produit doit fonctionner, mais la rédaction doit également montrer comment il fonctionne et pourquoi vous avez choisi chaque technique. Pour chaque technique importante :
- nommez-la ;
- montrez un court extrait pertinent de votre code ;
- expliquez ce qu'elle fait dans ce produit ;
- précisez pourquoi vous l'avez choisie plutôt qu'une alternative.
Exemple d'application. L'appariement trie les joueurs par classement, puis appaire les voisins, de sorte que les écarts de classement restent faibles :
def make_pairings(players):
"""Pair (name, rating) tuples; return the pairs and the bye."""
ranked = sorted(players, key=lambda p: p[1], reverse=True)
bye = None
if len(ranked) % 2 == 1:
bye = ranked.pop() # lowest rating sits out
pairs = []
for i in range(0, len(ranked), 2):
pairs.append((ranked[i][0], ranked[i + 1][0]))
return pairs, bye
Explication. Trier par classement place les joueurs de niveau similaire à côté les uns des autres, donc l'appariement des voisins donne les plus petits écarts de classement ; cela satisfait le critère d'équité. Avec un nombre impair de joueurs, le joueur au classement le plus bas reçoit une bye, ce que vérifie le test 4. Un appariement aléatoire serait plus simple, mais il pourrait opposer le joueur le plus fort à un débutant.
Une liste de toutes les fonctionnalités Python utilisées n'est pas une explication. Choisissez les techniques importantes, comme un tri, une recherche, un fichier ou une base de données, une validation, une classe, et expliquez-les correctement.
Utiliser le travail d'autrui
Si vous utilisez une bibliothèque, un exemple de code provenant d'un site web ou un outil IA, indiquez d'où il provient et ce que vous y avez changé. Cela relève de l'intégrité académique : tout travail qui n'est pas le vôtre doit être cité. Votre propre explication du fonctionnement du code montre que vous le comprenez.