-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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
Re-evaluate core variable & parameter identifier/type order (including a default for parameters) #542
Comments
Thumbs-up for OK with T:ND, rocket if it's your favorite. |
Thumbs-up for OK with TND, rocket if it's your favorite. |
Thumbs-up for OK with N:TD, rocket if it's your favorite. |
Decision: consensus is here for N:TD |
A nit-picky question here, but useful for consistency: what formatting should we use? I think the overwhelming answer is FWIW, I had somehow seen |
I would like to see our examples without a space before the colon and with one after, so |
Users will definitely want to be able to align things:
and I do not think we should fight them on it |
Yep, I think we're all aligned that this is just about what the canonical formatting in examples looks like. I'm even open to evaluating a more column-oriented formatting when/if we have a formatter tool, I just wanted to know what baseline to use in examples prior to that. |
Closing this out as I think the majority of updates to our existing syntax examples have landed. |
Propose the decision from #542, noting implementation from #563 Also integrates some of #339 into `variables.md` because that's actually how this started, looking for a proposal reference for #542 Co-authored-by: Richard Smith <[email protected]> Co-authored-by: josh11b <[email protected]>
Propose the decision from #542, noting implementation from #563 Also integrates some of #339 into `variables.md` because that's actually how this started, looking for a proposal reference for #542 Co-authored-by: Richard Smith <[email protected]> Co-authored-by: josh11b <[email protected]>
Somewhat condensed, bullet-point-y background for this question:
Type: variable
and thenType variable
syntax in variables, parameters, and other declarations.Type variable
.@josh11b has provided a really nice and pretty comprehensive overview of the choices here, as well as all of the ways the might interact with the more complete syntax picture here ranging from functions to match cases:
https://docs.google.com/document/d/1EhZA3AlY9TaCMho9jz2ynFxK-6eS6BwMAkE5jNYQzEA/edit?resourcekey=0-QXEoh-b4_sQG2u636gIa1A
[Update: the above link replaced
https://docs.google.com/document/d/1iuytei37LPg_tEd6xe-O6P_bpN7TIbEjNtFMLYW2Nno]The three core options outlined in that document are:
Type: name = default
.Type name = default
.name : Type = default
.If folks have other syntaxes they'd like to consider, I'd somewhat suggest building something similar to this document to allow folks to evaluate them. I would also suggest that we should focus our time here on picking an option based on the information we have and not expanding our options. I think this is something that we can (and likely will) revisit if we get new information in the future (including new, compelling syntaxes that have be tried out and clearly shown to be interesting to consider). Right now, I think the most valuable thing is to pick something and focus our efforts.
Relatedly, I'd like to avoid diving into long and detailed discussions of data (surveys, user studies, etc) that we should collect to inform this decision. I'm actually really interested in this area, and I think it is something the project should eventually do, but my goal with this question is to ask the leads to pick a syntax to use in the absence of effective / compelling data-based studies. I hope that makes sense to folks.
One bit of data that I think we can easily and immediately collect is just fresh polls of the existing community members. I'm going to create a comment on this issue for each of the three options above. Please react with a "thumbs-up" for all the options that you'd be OK with -- and I encourage being a bit generous here. Even if you'd rather not, unless it seems like a serious problem, I'd suggest giving it a thumbs-up. Please react to at most one of these options with a "rocket" to indicate your favorite. Putting this here so we have a bit more of a record and so folks not active on Discord can find it.
The text was updated successfully, but these errors were encountered: