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

Start of a symbol/operator glossary #1279

Merged
merged 13 commits into from
Dec 15, 2021
Merged

Start of a symbol/operator glossary #1279

merged 13 commits into from
Dec 15, 2021

Conversation

muttoni
Copy link
Contributor

@muttoni muttoni commented Nov 26, 2021

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


  • Targeted PR against master branch
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work
  • Code follows the standards mentioned here
  • Updated relevant documentation
  • Re-reviewed Files changed in the Github PR explorer
  • Added appropriate labels

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).
Copy link
Member

@turbolent turbolent left a 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 👍

docs/language/glossary.md Outdated Show resolved Hide resolved
docs/language/glossary.md Outdated Show resolved Hide resolved
docs/language/glossary.md Outdated Show resolved Hide resolved
docs/language/glossary.md Show resolved Hide resolved
docs/language/glossary.md Outdated Show resolved Hide resolved
docs/language/glossary.md Outdated Show resolved Hide resolved
docs/language/glossary.md Outdated Show resolved Hide resolved
docs/language/glossary.md Outdated Show resolved Hide resolved
docs/language/glossary.md Outdated Show resolved Hide resolved
docs/language/glossary.md Outdated Show resolved Hide resolved
@turbolent turbolent added the Documentation Improvements or additions to documentation label Nov 26, 2021
@codecov-commenter
Copy link

Codecov Report

Merging #1279 (104967c) into master (38dd571) will increase coverage by 0.02%.
The diff coverage is n/a.

Impacted file tree graph

@@            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     
Flag Coverage Δ
unittests 77.34% <ø> (+0.02%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
runtime/sema/check_cast_visitor.go 84.84% <0.00%> (ø)
runtime/sema/checker.go 89.64% <0.00%> (+0.02%) ⬆️
runtime/sema/check_casting_expression.go 96.73% <0.00%> (+0.16%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 38dd571...104967c. Read the comment docs.

@turbolent
Copy link
Member

@muttoni any update here?

muttoni and others added 10 commits December 15, 2021 11:41
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]>
@muttoni
Copy link
Contributor Author

muttoni commented Dec 15, 2021

@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! :)

Copy link
Member

@turbolent turbolent left a 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

@turbolent turbolent merged commit 4cb7c7c into onflow:master Dec 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants