-
Notifications
You must be signed in to change notification settings - Fork 137
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
Start of a symbol/operator glossary #1279
Conversation
I've been going through the Cadence reference documentation and started collating information about all the symbols and operators. While it doesn't completely satisfy the need for a comprehensive glossary mentioned in onflow#959, it can perhaps be a step in that direction and help developers who are learning Cadence to quickly look up the various symbols (something that is hard to do in the documentation Algolia search bar. For example `as?` does not return any useful result).
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.
Nice! Thank you for writing this up 👍
Codecov Report
@@ Coverage Diff @@
## master #1279 +/- ##
==========================================
+ Coverage 77.32% 77.34% +0.02%
==========================================
Files 274 275 +1
Lines 35372 35450 +78
==========================================
+ Hits 27350 27418 +68
- Misses 6943 6949 +6
- Partials 1079 1083 +4
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
@muttoni any update here? |
Co-authored-by: Bastian Müller <[email protected]>
Co-authored-by: Bastian Müller <[email protected]>
Co-authored-by: Bastian Müller <[email protected]>
Co-authored-by: Bastian Müller <[email protected]>
Co-authored-by: Bastian Müller <[email protected]>
Co-authored-by: Bastian Müller <[email protected]>
Co-authored-by: Bastian Müller <[email protected]>
Co-authored-by: Bastian Müller <[email protected]>
Co-authored-by: Bastian Müller <[email protected]>
Co-authored-by: Bastian Müller <[email protected]>
@turbolent sorry, did not get any notifications on this (fixed the settings now). Committed all changes, thanks for the suggestions! Let me know if there's anything else I can improve! :) |
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.
Thank you! Next step is to add this to https://github.com/onflow/flow/blob/0d2288e3d0f248929a85aad7eb25ce59306132cc/docs/gatsby-config.js#L617 so it shows up in the sidebar of the documentation page
Partly addresses #959
Description
I've been going through the Cadence reference documentation and started collating information about all the symbols and operators. While it doesn't completely satisfy the need for a comprehensive glossary mentioned in #959, it can perhaps be a step in that direction and help developers who are learning Cadence to quickly look up the various symbols (something that is hard to do in the documentation Algolia search bar. For example
as?
does not return any useful result).I've created a new file called
glossary.md
master
branchFiles changed
in the Github PR explorer