LaboratoireMecaniqueLille / crappy

Command and Real-time Acquisition Parallelized in Python
https://crappy.readthedocs.io/en/stable/
GNU General Public License v2.0
78 stars 16 forks source link

Refactor change-set information #105

Closed WeisLeDocto closed 6 months ago

WeisLeDocto commented 6 months ago

Since release 2.0.2 (specifically commit 6ec2eb28), change-set information was added to the documentation in order to make it clear at which point in the project's history the changes in the API occurred. However, the change-set information was included in the documentation after the description of the arguments.

In this PR, the change-set information is moved inside the argument description, effectively tying it up with the described arguments. Users are less likely to miss this information, and developers are more likely to remember to update it when needed. Only the information about deleted arguments was kept after the argument description.