search

hu-macsy / simexpal

Simplifying Experimental Algorithmics
https://simexpal.readthedocs.io
MIT License
17 stars 18 forks source link

Revise CLI Documentation #159

Closed c-bebop closed 9 months ago

c-bebop commented 10 months ago

This PR addresses issue #56

Most of the changes are minimal, and only represent revisions of already present documentation. Only the queue documentation is new.

The rendering of the documentation is available under: https://simexpal-fork.readthedocs.io/en/simexpal_doc_56/command_line_reference.html

c-bebop commented 9 months ago

In general the "Responsible to xy" phrase in each section sounds weird to me. Seems like the Oxford dictionary allows it, but to me it feels very unusual. Can we change this to "Responsible for" or some other word instead of responsible? Instances and Queue have better intro text imo.

Just changed this to 'Used to...'.