Skip to content

Commit

Permalink
Update readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
Gouvernathor committed May 25, 2024
1 parent 2b739c9 commit 14cdff8
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 6 deletions.
6 changes: 4 additions & 2 deletions LISEZMOI.rst
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,8 @@ sont les suivants :

- ``file: str|io.TextIOBase`` : un fichier ouvert en mode texte, ou le chemin
vers le fichier sur lequel écrire. Si un chemin est fourni, le fichier sera
créé si il n'existe pas, et sera écrasé sinon.
écrit sous l'encodage UTF-8, et il sera créé si il n'existe pas et sinon
réécrit.
- ``attrib: dict[SeatData, int]`` : un dictionnaire d'objets SeatData
s'appliquant à un ensemble de sièges présents dans l'hémicycle, vers le nombre
de sièges auxquels l'objet s'applique. Typiquement, chaque objet correspond à
Expand Down Expand Up @@ -201,7 +202,8 @@ sont les suivants :

- ``file: str|io.TextIOBase`` : un fichier ouvert en mode texte, ou le chemin
vers le fichier sur lequel écrire. Si un chemin est fourni, le fichier sera
créé si il n'existe pas, et sera écrasé sinon.
écrit sous l'encodage UTF-8, et il sera créé si il n'existe pas et sinon
réécrit.
- ``seat_centers: dict[tuple[float, float], SeatData]`` : un dictionnaire des
coordonnées (x, y) des centres des sièges vers des objets SeatData.
- ``seat_actual_radius: float`` : le rayon des sièges, tel que renvoyé par
Expand Down
10 changes: 6 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,9 @@ This function writes an SVG file representing a hemicycle. The parameters are as
follows:

- ``file: str|io.TextIOBase``: a file-like object open in text mode, or the path
to the file to write on. If a path is provided, the file will be created if it
doesn't exist, and otherwise overwritten.
to the file to write on. If a path is provided, the file will be written to in
UTF-8 encoding, and it will be created if it doesn't exist or overwritten if
it does.
- ``attrib: dict[SeatData, int]``: a mapping from a SeatData object applying to
a number of seats in the resulting hemicycle, to the number of seats each
object applies to. Typically, each SeatData object corresponds to a group or
Expand Down Expand Up @@ -199,8 +200,9 @@ This function writes an SVG file representing a hemicycle. The parameters are as
follows:

- ``file: str|io.TextIOBase``: a file-like object open in text mode, or the path
to the file to write on. If a path is provided, the file will be created if it
doesn't exist, and otherwise overwritten.
to the file to write on. If a path is provided, the file will be written to in
UTF-8 encoding, and it will be created if it doesn't exist or overwritten if
it does.
- ``seat_centers: dict[tuple[float, float], SeatData]``: a mapping from the
(x, y) coordinates of each seat's center to a SeatData object.
- ``seat_actual_radius: float``: as output by ``get_seats_centers``.
Expand Down

0 comments on commit 14cdff8

Please sign in to comment.