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

Docs: further documentation of static features #1885

Open
anshumanmohan opened this issue Jan 29, 2024 · 0 comments
Open

Docs: further documentation of static features #1885

anshumanmohan opened this issue Jan 29, 2024 · 0 comments
Labels
C: Docs Documentation to add/improve S: Available Can be worked upon

Comments

@anshumanmohan
Copy link
Contributor

I have made progress on documenting the static qualifier, but have left out some advanced magic since it may belong elsewhere.

@sampsyo has summed up the TODO nicely, so I'll let him take it away:

I have put nothing in there about refinement; it's perhaps "just a cute detail" as far as the user is concerned. Thoughts?

I think it would be great to add something about this someday, but in a separate PR! Namely, a thing that users might want to know is the following paradigm for how they might use static:

  1. Emit fully dynamic code everywhere.
  2. Observe places where performance is suffering because static inference was incomplete.
  3. Sprinkle static qualifiers in there.

The relevant idea offered by refinement is that step 3 is guaranteed not to break the program.

By this logic, I'd say that inference should be presented here, but I'm not sure about compaction. Thoughts?

Yep!! In particular, maybe we can talk about inference/promotion when we add stuff about refinement above. It's good for people to know this pass exists; the details of how it works or how capable it is probably are not worth writing down. Compaction seems like "just an optimization" like any other, i.e., it can be documented like any other optimization pass.

Originally posted by @sampsyo in #1872 (review)

@rachitnigam rachitnigam added S: Available Can be worked upon C: Docs Documentation to add/improve labels Feb 1, 2024
@anshumanmohan anshumanmohan changed the title Static docs: further steps Docs: further documentation of static features May 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C: Docs Documentation to add/improve S: Available Can be worked upon
Projects
None yet
Development

No branches or pull requests

2 participants