dragonfly icon indicating copy to clipboard operation
dragonfly copied to clipboard

Published 20 hours ago • verified publisher icon dictation-toolbox

Missing documentation

Open drmfinlay opened this issue 5 years ago • 2 comments

There are a number of parts of dragonfly that are not documented. I'll list some of them below.

  • [x] A pylintrc file for the project's code style (mostly PEP 8).

  • [x] List and DictList classes.

  • [ ] Classes in the dragonfly.language sub-package (except ShortIntegerRef). E.g. IntegerRef, Integer, Digits

  • [X] Classes in the dragonfly.windows sub-package (except Clipboard). Windows only modules such as win32gui are mocked for documentation builds, so that shouldn't be an issue.

  • [x] Information on cross-platform support

    • which platforms are supported
    • what functionality is supported

  • [x] Cross-platform pyperclip Clipboard class in dragonfly.util.clipboard.

  • [x] Separate documentation pages on the Natlink, WSR and text-input engine back-ends.

drmfinlay avatar May 04 '19 14:05 drmfinlay

I approve of adding pylintrc. In fact I would go as far to find a system that automatically formats pull requests to Prep8.

LexiconCode avatar May 05 '19 01:05 LexiconCode

@LexiconCode Possibly. I'd prefer something that just checked the code, e.g. using pylint in the Travis CI build. Aenea does something like this with pyflakes.

drmfinlay avatar May 05 '19 05:05 drmfinlay