Ajout de la documentation #4
Conversation
Situphen
requested review from
AmauryCarrade and
EtoileFilante
and removed request for
AmauryCarrade
|
@EtoileFilante : Aucun changement à faire pour toi ? Tu avais pourtant l'air de vouloir changer des choses lors du dernier ZdC. |
|
Ça me paraît déjà pas mal, ensuite je n'ai pas eu le temps de reprendre mes différents points encore. Si besoin je ferai une autre PR plus tard ;) |
| Enfin, on rappelle les deux types de variables : | ||
|
|
||
| - **locale** : disponible uniquement dans la fonction en cours ; | ||
| - **interne** : disponible partout où l'objet concerné est présent (pratique pour passer une variable de `initialisation` à `boucle`, par exemple). | ||
|
|
||
| Les deux types de fonctions sont de même nature : | ||
|
|
||
| - **principale** : disponible pour le fichier en cours ; | ||
| - **interne** : peut être utilisée par le jeu lui-même (c'est le cas de `boucle`, par exemple) ou utilisée depuis la variable jeu (`jeu.quitter()` par exemple). |
There was a problem hiding this comment.
Peu clair, je trouve. En fait même moi je ne trouve pas ça clair : on parle bien des variables locales et des attributs d'objets ?
There was a problem hiding this comment.
Clarification souhaitée, en effet, mais je ne sais pas comment m'y prendre.
On parle des variables locales / globales que je regroupe en "locales" ici, et des attributs (variables dites "internes"). Même chose pour les fonctions.
Je ne sais pas à quel point l'abstraire, donc pas bien sûr de comment l'aborder.
| print("Collision Serpent-Pomme") | ||
| ``` | ||
|
|
||
| Vérifiera s'il y a collision entre la pomme et la variable nommée `morceau.position`. |
There was a problem hiding this comment.
Peu clair potentiellement quand on ne connaît pas du tout Python (d'où vient ce .position ?).
|
|
||
| ## Déclaration de l'objet Serpent | ||
|
|
||
| Après avoir importé la bibliothèque Zeste de Code, tu auras accès aux fonctions concernant le serpent. Une nouvelle instance de serpent devra ensuite être crée, préférentiellement à l'intérieur du jeu : |
There was a problem hiding this comment.
Le mot instance n'a jamais été vu avant. Quid ?
There was a problem hiding this comment.
+ correction orthographique : "crée" -> "créée"
There was a problem hiding this comment.
C'est vraiment gênant ? Le mot instance me semble assez transparent ici : "une nouvelle instance du serpent" = "un nouveau serpent".
@Situphen : corrigé.
| jeu.serpent.PARTIES.QUEUE | ||
| ``` | ||
|
|
||
| Notons que lors de l'itération, les parties sont ordonnées dans le sens inverse (et si tu ne comprends rien à cette phrase, reviens plus tard). |
There was a problem hiding this comment.
Le plus tard est à peine plus bas. Peut-être vaudrait-il mieux reformuler cette partie, ou retirer cette phrase au profit du paragraphe « Position du serpent » (ou y laisser un pointeur : « on verra un peu plus bas comment s'en servir »…)
|
|
||
| # Position du serpent | ||
|
|
||
| Un itérateur existe et permet d'obtenir tous les morceaux de serpent dans l'ordre allant de la queue à la tête, il s'agit de `serpent.morceaux(taille)` ; le seul argument est la taille du serpent, ou plus simplement le nombre de morceaux à prendre. Pour afficher les positions successives du serpent : |
There was a problem hiding this comment.
Par rapport au code : pourquoi demander la taille en paramètre quand elle est stockée dans l'objet de toute façon ?
There was a problem hiding this comment.
Pour pouvoir itérer sur une partie des morceaux seulement ; aucune idée de pourquoi je voulais faire ça, mais clairement c'était à dessein. TODO: voir si c'est utilisé.
Co-Authored-By: Amaury Carrade <[email protected]>
|
J'ai corrigé les problèmes qui me semblent parfaitement justifiés, et laissé un commentaire sur les autres pour débattre. Pour la position et la modification du code, je fais ça dans un prochain commit avec le "plus tard" que j'ai zappé dans celui-ci. |
| - `mon_jeu.hauteur`, qui contient la hauteur de la fenêtre ; | ||
| - `mon_jeu.evenements`, qui contient la liste des événements déclenchés depuis le dernier tour de boucle. | ||
|
|
||
| La variable `evenments` nous intéressera particulièrement, et nous pourrons vérifier si un certain événement est déclenché en utilisant une condition : |
There was a problem hiding this comment.
| La variable `evenments` nous intéressera particulièrement, et nous pourrons vérifier si un certain événement est déclenché en utilisant une condition : | |
| La variable `evenements` nous intéressera particulièrement, et nous pourrons vérifier si un certain événement est déclenché en utilisant une condition : |
Petite PR parce que j'avais du temps hier ; j'ajoute à ce repo la documentation du dernier atelier. Cette PR devrait rester ouverte pour review, AMHA ; j'ai un script de rendu HTML en local, mais il dépends d'un fonctionnalité pas encore intégrée dans ZMarkdown donc pas possible de pousser ça ici pour le moment. Dans la mesure du possible, si vous corrigez le Markdown, je ferais un export HTML global avant de merge.