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

The docs for "use:" are not clear #233

Open
viridia opened this issue Feb 10, 2023 · 0 comments
Open

The docs for "use:" are not clear #233

viridia opened this issue Feb 10, 2023 · 0 comments

Comments

@viridia
Copy link

viridia commented Feb 10, 2023

There's a pattern that I sometimes see in documentation, where an author will describe the motivating use case, and example usage, while forgetting to actually state what the function does. (This is still better than the inverse, which is more common: explaining the solution without ever stating the problem).

The docs for use: are an example of this - it talks about why and where you might want to use this directive, but it never actually describes what effect the directive has. And unfortunately, I am not able to deduce the functionality by looking at the example code - what I read just makes no sense to me.

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

1 participant