Extend documentation - Githubissues

DiamondLightSource / cssgen

Python to generate CS-Studio OPI files

Other

0 stars 4 forks source link

Extend documentation #38

Open nickbattam opened 7 years ago

nickbattam commented 7 years ago

Taking from a comment on #22:

Add docstrings
Add some developer documentation

nickbattam commented 7 years ago

One area really needs documenting is what the arguments to the various model objects are (e.g. Border(style, width, color, alarm). With the current (lack of) documentation I have no idea what constants are valid for style or what alarm means, OpenOpi(path, mode) - it not at all obvious that mode is one of the OpenOpi contants.