search

SNSystems / dexter

DExTer - Debug Experience Tester
MIT License
33 stars 6 forks source link

Improve documentation #39

Closed OCHyams closed 5 years ago

OCHyams commented 5 years ago

Update README.md - it was fairly out of date.

Add Command.md - document which covers Dexter commands for users (test writers)

Improve docstrings - Use "Google style" ish docstrings to better document as much of Dexter as possible.

There is some very minor code clean up in places which could help self documentation, eg function names.

Note: I've written this as if PR #33 and #37 have landed.

jmorse commented 5 years ago

Tres bon; would merge but conflict in ParseCommand.py?

OCHyams commented 5 years ago

Fixed the conflict.