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

Documentation for useful functionality such as 'visible.When' #27

Open
DemonZito opened this issue Feb 11, 2021 · 1 comment
Open

Documentation for useful functionality such as 'visible.When' #27

DemonZito opened this issue Feb 11, 2021 · 1 comment

Comments

@DemonZito
Copy link
Contributor

Useful function is not documented anywhere.

@Splizard
Copy link
Contributor

I think this issue hints more broadly at improving the documentation of Qlovaseed. While the packages & functions are documented on pkg.go.dev, there needs to be better documentation on the discoverabillity of functionallity. If a feature is not documented, it does not exist! I think the examples that you and @SteveMaybe have been contributing are useful in this manner.

The Discussions page is also a suitable place to ask questions where answers are publicly available and presumably searchable (do github discussions appear on search engines?). Another approach is to setup the Wiki so that there is enough information to make use of the packages in this module and some exemplar use-cases. In any case, creating issues and asking questions gives me a better idea about what needs to be documented and how. So I appreciate the issue!

@Splizard Splizard changed the title Document visible.When Documentation for useful functionallity such as 'visible.When' Feb 13, 2021
@Splizard Splizard changed the title Documentation for useful functionallity such as 'visible.When' Documentation for useful functionality such as 'visible.When' Feb 13, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants