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

Document "displayName" Better #29

Closed
geirman opened this issue Jul 3, 2017 · 0 comments
Closed

Document "displayName" Better #29

geirman opened this issue Jul 3, 2017 · 0 comments

Comments

@geirman
Copy link

geirman commented Jul 3, 2017

Firstly, this looks like a great library. Well done, and the documentation looks pretty good as well. But...

image

The description does nothing to help someone understand how the displayName is used or why they'd care to set it. In fact, it doesn't tell me anything I couldn't already infer from the variable name itself. This is a common mistake I find in lots of documentation.

It's optional, so it would be more helpful if you told me why it exists. When would I want to bother setting this value? How is it useful? Why does this option exist? And if I set it, is it's value completely arbitrary, must it match my component's name, or what?

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