Skip to content

Commit 2445240

Browse files
Add notes about "versionadded" and "deprecated" admonitions
1 parent 73a6e5f commit 2445240

File tree

2 files changed

+32
-2
lines changed

2 files changed

+32
-2
lines changed

en/contributing/documentation.rst

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -339,7 +339,7 @@ Notes and warnings
339339

340340
There are often times when you want to inform the reader of an important tip,
341341
special note or a potential hazard. Admonitions in sphinx are used for just
342-
that. There are three kinds of admonitions.
342+
that. There are five kinds of admonitions.
343343

344344
* ``.. tip::`` Tips are used to document or re-iterate interesting or important
345345
information. The content of the directive should be written in complete
@@ -350,6 +350,12 @@ that. There are three kinds of admonitions.
350350
* ``.. warning::`` Warnings are used to document potential stumbling blocks, or
351351
information pertaining to security. The content of the directive should be
352352
written in complete sentences and include all appropriate punctuation.
353+
* ``.. versionadded:: X.Y.Z`` "Version added" admonitions are used to display notes
354+
specific to new features added at a specific version, ``X.Y.Z`` being the version on
355+
which the said feature was added.
356+
* ``.. deprecated:: X.Y.Z`` As opposed to "version added" admonitions, "deprecated"
357+
admonition are used to notify of a deprecated feature, ``X.Y.Z`` being the version on
358+
which the said feature was deprecated.
353359

354360
All admonitions are made the same::
355361

@@ -374,6 +380,14 @@ Samples
374380

375381
It could be dangerous.
376382

383+
.. versionadded:: 2.6.3
384+
385+
This awesome feature was added on version 2.6.3
386+
387+
.. deprecated:: 2.6.3
388+
389+
This old feature was deprecated on version 2.6.3
390+
377391

378392
.. meta::
379393
:title lang=en: Documentation

fr/contributing/documentation.rst

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -358,7 +358,7 @@ Notes et avertissements
358358

359359
Il y a souvent des fois où vous voulez informer le lecteur d'une astuce
360360
importante, une note spéciale ou un danger potentiel. Les avertissements
361-
dans sphinx sont justement utilisés pour cela. Il y a trois types
361+
dans sphinx sont justement utilisés pour cela. Il y a cinq types
362362
d'avertissements.
363363

364364
* ``.. tip::`` Les astuces sont utilisées pour documenter ou réitérer des
@@ -373,6 +373,14 @@ d'avertissements.
373373
potentiellement dangereux, ou des informations relatives à la sécurité. Le
374374
contenu de la directive doit être écrite en phrases complètes et inclure
375375
toute la ponctuation appropriée.
376+
* ``.. versionadded:: X.Y.Z`` Les avertissements "ajouté en version X.Y.Z" sont
377+
utilisés pour spécifier l'ajout de fonctionnalités dans une version spécifique,
378+
``X.Y.Z`` étant la version à laquelle l'ajout de la fonctionnalité en question a
379+
eu lieu
380+
* ``.. deprecated:: X.Y.Z`` À la différence des avertissements "ajouté en version",
381+
les avertissements "déprécié en version" servent à indiquer la dépréciation d'une
382+
fonctionnalité à une version précise, ``X.Y.Z`` étant la version à laquelle le retrait
383+
de la fonctionnalité en question a eu lieu
376384

377385
Tous les avertissements sont faits de la même façon::
378386

@@ -398,6 +406,14 @@ Exemples
398406

399407
Cela pourrait être dangereux.
400408

409+
.. versionadded:: 2.6.3
410+
411+
Cette super fonctionnalité a été ajoutée en version 2.6.3
412+
413+
.. deprecated:: 2.6.3
414+
415+
Cette vieille fonctionnalité a été dépréciée en version 2.6.3
416+
401417

402418
.. meta::
403419
:title lang=fr: Documentation

0 commit comments

Comments
 (0)