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

Suggested improvements to the language manual #1142

Open
pmundkur opened this issue Mar 11, 2025 · 1 comment
Open

Suggested improvements to the language manual #1142

pmundkur opened this issue Mar 11, 2025 · 1 comment
Labels
documentation Issues relating to documentation enhancement New feature or request

Comments

@pmundkur
Copy link
Contributor

The below constructs are under-discussed or missing in the manual:

  • register (this is mentioned in the Tutorial portion and elsewhere, and is probably obvious, but a core construct like this deserves its own dedicated section in the Language section)
  • assert (the manual uses assert liberally without really specifying what it does)
  • instantiation ... with (this shows up in prelude_mem.sail in the RISC-V model)
  • pure and impure (used as FFI annotations in the RISC-V model)
  • foreach : (the grammar indicates there are also foreach ... by and foreach ... by .. in flavors; are they useful?)
@Alasdair Alasdair added enhancement New feature or request documentation Issues relating to documentation labels Mar 11, 2025
@Alasdair
Copy link
Collaborator

Yes, thanks for creating an issue to track these.

I wonder if this would be a good time to use the Create sub-issue button I now see on Github?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issues relating to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants