-
Notifications
You must be signed in to change notification settings - Fork 419
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
chore: syntax documentation for universe
, open
, export
, variable
#2645
chore: syntax documentation for universe
, open
, export
, variable
#2645
Conversation
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a great improvement, thanks!
I think it can be even better with some small modifications. They come in a few categories:
- Describing not just what the feature does, but also the problems that it solves for users
- Using less-abstract examples that are more likely to be understood by our audiences
- Reducing the technical programming-languages jargon
- Picking syntactic metavariables that have less potential for confusion
Thanks again, and please let me know if there's anything unclear in my comments!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It looks like you've made great progress on it!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Almost there! I'm happy to finish this up if you're getting discouraged, but I think there's just a couple minor details and then I'll think we're good to go. Thank you so much for your patience!
…laring variables
External Contribution Guidelines.
Mentored by @digama0, adds syntax-documentation with examples to
universe
,open
,export
, andvariable
.The documentation shows up when hovering over keywords, hopefully improving the experience for beginners.