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.

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

Fix classes with missing/incorrect descriptions #404

Open
cjbrooks12 opened this issue Jul 5, 2021 · 1 comment
Open

Fix classes with missing/incorrect descriptions #404

cjbrooks12 opened this issue Jul 5, 2021 · 1 comment
Labels
chore documentation Task Type: Improvements to documentation content or site design good first issue
Milestone

Comments

@cjbrooks12
Copy link
Contributor

There are a handful of classes that do not properly document themselves, or document themselves incorrectly. Orchid needs to be updated so that all common extension classes contain an @Description annotation on the class and all of its @Option properties, and that all of those descriptions are correct.

@cjbrooks12 cjbrooks12 added documentation Task Type: Improvements to documentation content or site design good first issue chore labels Jul 5, 2021
@cjbrooks12 cjbrooks12 added this to the 1.0.0 milestone Jul 5, 2021
@andyslucky
Copy link

I think another related issue is availability / comprehensive documentation for those that would like to use and extend orchid. I found very little help or documentation while working on a plugin for work.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore documentation Task Type: Improvements to documentation content or site design good first issue
Projects
None yet
Development

No branches or pull requests

2 participants