The Wayback Machine - https://web.archive.org/web/20220501113515/https://github.com/ethereum/solidity/issues/12934
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

More concise "Cheatsheet" page #12934

Open
7 tasks
cameel opened this issue Apr 13, 2022 · 0 comments
Open
7 tasks

More concise "Cheatsheet" page #12934

cameel opened this issue Apr 13, 2022 · 0 comments

Comments

@cameel
Copy link

@cameel cameel commented Apr 13, 2022

Page

Abstract

Currently the "Cheatsheet" page largely repeats the information already available in "Units and Globally Available Variables". This info is already concise and in effect we're just maintaining it in two places. Cheatsheet should have much less detail. Having information that's not as succintly described elsewhere would also be much more useful.

Here's what I think we should do:

  • Remove excessive detail from the cheatsheet. If the info is only available there, move it to a different location.
    • Notes/warnings should not be there
    • "Global Variables" section would be better off as a table.
    • Members of address, type, etc. should be in a separate section, not under "Global Variables".
    • The operator precedence should be under Types > Operators. Maybe it makes sense to have a copy here but that's also extra maintenance so I'd just move it.
    • I think that the list of keywords should be moved to "Units and Globally Available Variables". It does not fit that page perfectly but is a bit related.
  • Add missing info
    • Members available on functions, errors, events.
    • Make sure that the list of "Global Variables" contains every item from "Units and Globally Available Variables"
@cameel cameel added this to New issues in Solidity via automation Apr 13, 2022
@cameel cameel changed the title More concise "Cheatseet" page More concise "Cheatsheet" page Apr 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment