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

feature request: pluscal/tla cheatsheet #68

Open
acud opened this issue Jul 28, 2023 · 2 comments
Open

feature request: pluscal/tla cheatsheet #68

acud opened this issue Jul 28, 2023 · 2 comments

Comments

@acud
Copy link
Contributor

acud commented Jul 28, 2023

While going through the website and trying to write some specs, it was noticeable that there's a certain lack of a page that puts it all together in a way that one can easily refer to and see the big picture.

As an example I can give this, a really nice Rust cheatsheet page.

Due to the semantic differences in basic operators between PlusCal/TLA and conventional languages, I think this could be something that would help people to more easily onboard.

It is, however, an undertaking, but it would definitely be useful.

The Standard Modules page exists, and it could be repurposed to do this. It appears that the current purpose of the page is to serve as a "standard library" equivalent for Pluscal/TLA. However, given that the standard library is pretty mature (and lean), it might be more informative and helpful to just "spec it all out" with the stuff that's been left out - the actual nuts and bolts that are given in the guide (from the most basic things like operators, conditionals, logical operators, etc). I find myself running through the entire guide trying to figure out how to do very basic things still, and it's definitely a time consumer since one needs to keep a mind-map of where a given concept has been introduced. This is especially noticeable in the first few chapters where all the basics are spread out.

Would be interested to hear what you think of this.

@hwayne
Copy link
Owner

hwayne commented Jul 28, 2023

I agree, this would be really helpful. It's just a lot of work to implement, so it might take some time. I'd prefer to do it as a separate page from the standard modules.

What do you think of the legacy learntla reference pages? Would you be willing to try them for a few days and tell me the point points on those?

@acud
Copy link
Contributor Author

acud commented Jul 31, 2023

Sure 👍

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

2 participants