Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Missing documentation #77

Open
6 of 7 tasks
drmfinlay opened this issue May 4, 2019 · 2 comments
Open
6 of 7 tasks

Missing documentation #77

drmfinlay opened this issue May 4, 2019 · 2 comments
Assignees
@drmfinlay
Labels
Documentation Issues related to documentation

Comments

@drmfinlay
Copy link
Member

drmfinlay commented May 4, 2019 •
edited
Loading

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

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

  • List and DictList classes.

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

  • 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.

  • Information on cross-platform support

    • which platforms are supported
    • what functionality is supported

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

  • Separate documentation pages on the Natlink, WSR and text-input engine back-ends.
@drmfinlay drmfinlay added the Documentation Issues related to documentation label May 4, 2019
@LexiconCode
Copy link
Member

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

@drmfinlay
Copy link
Member Author

@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 drmfinlay mentioned this issue Jul 16, 2019
Merged
drmfinlay added a commit that referenced this issue Oct 12, 2019
@drmfinlay
Add missing documentation on recognition observers
5869d09 
Re: #77.
@drmfinlay drmfinlay self-assigned this Oct 12, 2019
drmfinlay added a commit that referenced this issue Oct 31, 2019
@drmfinlay
Add code style info into empty documentation page
4482c64 
Re: #77.
This was referenced Nov 12, 2019
Merged
Merged
@drmfinlay drmfinlay mentioned this issue Feb 4, 2020
Merged
drmfinlay added a commit that referenced this issue Jul 10, 2020
@drmfinlay
Update Clipboard toolkit documentation
4ebdd7a 
Re: #77.

The Clipboard toolkit documentation section now includes
information on the cross-platform Clipboard class as well as which
Clipboard class is the default on which platform.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@drmfinlay drmfinlay

Labels
Documentation Issues related to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@drmfinlay @LexiconCode