Commit 6d460875 authored by Robert Sebille's avatar Robert Sebille

Corrections mineures à la documentation. Seront intégrées automatiquement à la...

Corrections mineures à la documentation. Seront intégrées automatiquement à la prochaine version pip
parent 76222586
......@@ -10,7 +10,7 @@ Les frames peuvent être dans un seul fichier, avec un séparateur ou dans plusi
- [Dépot](https://framagit.org/zenjo/film/tree/master)
- [Wiki](https://framagit.org/zenjo/film/wikis/home)
- [Documentation sphinx](https://docs.sebille.name/ascii-films/
- [Documentation sphinx](https://docs.sebille.name/ascii-films/)
......@@ -131,8 +131,8 @@ class Film:
self._frames.append(l.split("\n"))
self._nb_frames_per_file += 1
frame = property('', set_frame, '', "Lit les frames à partir d'un seul\
fichier. Ces frames sont séparées par un séparateur, par défaut #")
frame = property('', set_frame, '', "Retourne ou lit les frames à partir \
d'un seul fichier. Ces frames sont séparées par un séparateur, par défaut #")
def set_frames(self, repertoire):
frms = []
......@@ -143,10 +143,10 @@ class Film:
self._frames.append(f.split("\n"))
self._nb_frames_per_file = 1
frames = property('', set_frames, '', "Lit les frames à partir de \
fichiers dans répertoire. Chaque frame est dans un fichier propre. Les \
fichiers sont lus dans le répertoire dans le sens alphnumérique croissant \
de leurs noms.")
frames = property('', set_frames, '', "Retourne ou lit les frames à \
partir de fichiers dans un répertoire. Chaque frame est dans un fichier \
propre. Les fichiers sont lus dans le répertoire dans le sens alphnumérique \
croissant de leurs noms.")
def get_nb_frames_per_file(self):
return self._nb_frames_per_file
......@@ -226,7 +226,8 @@ de leurs noms.")
obj.sous_titre_xy = (x, y) # tuple
La zone de sous-titres débute à la coordonnée x de la largeur
fixée, par défaut 40 par l'attribut sous_titres_largeur.
fixée (par défaut 40) par l'attribut sous_titres_largeur. Les sous-titres
sont centrés dans cette zone.
.. note::
Pour mieux voir et comprendre ceci, mettez le paramètre
......@@ -254,7 +255,7 @@ de leurs noms.")
sous_titres_reverse = property(get_sous_titres_reverse,
set_sous_titres_reverse, '',
"""
Retourne ou fixe l'affichage des sous-titres est reverse ou non.
Retourne ou fixe l'affichage des sous-titres à reverse ou non.
(booléen) Défaut = False""")
def get_deplacement(self):
......@@ -316,11 +317,12 @@ de leurs noms.")
def projection(self, nb_frames=0, x=2, y=4, trace=0, delai=0.1):
"""Lance l'instance film en lisant les frames.
- nb_frames: nombre de frames à exécuter. 0 = non déterminé
- nb_frames: nombre de frames à exécuter. 0 = infini
- x, y: les coordonnées haut gauche de départ du film
(y compris le titre, si self.affiche_titre = True)
- trace nombre de blancs à ajouter à la frame suivant le sens du film
(avant si self.reverse = False, après si self.reverse = True)
- trace nombre de blancs à ajouter à la frame suivant le sens du film.
A gauche si self.reverse = False, à droite si self.reverse = True.
Ce paramètre sert à effacer d'éventuelles traces laissées par une
frame pas trop bien :) formatée.
- delai: la durée en seconde de chaque frame
.. warning:: Si self.reverse = True, le film peut avoir des effets de
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment