Design overview update part 1 #1274
Conversation
Co-authored-by: Geoff Romer <gromer@google.com>
There was a problem hiding this comment.
Discussed the structure a bit with Josh, and he made a good point that it is much more likely to be productive to revisit the structure as the content becomes more complete. I'm pretty happy postponing too much more debate around the macro level structure and getting the content in place, so I've tried to avoid further comments there.
Most of the comments are actually pretty minor or trivial tweaks. I think I started fading a bit in the second half of the document, but overall this is looking generally quite good to me. See the tweaks in line.
docs/design/README.md
Outdated
|
|
||
| ### Expressions | ||
| Decimal and hexadecimal real-number literals are supported: |
There was a problem hiding this comment.
Maybe add a bit of an introduction to transition from "floating-point literals" in the section heading to "real-number literals" with a bit of the justification?
Co-authored-by: Chandler Carruth <chandlerc@gmail.com>
| This document is _not_ a complete programming manual, and, nor does it provide | ||
| detailed and comprehensive justification for design decisions. These | ||
| descriptions are found in linked dedicated designs. |
There was a problem hiding this comment.
One thing that I was wondering as I skimmed this was, would it make sense to only include individual proposals when they aren't yet integrated into the dedicated design?
There was a problem hiding this comment.
That would be less maintenance, but I do think including all relevant proposals will provide value to our target audience. Generally the titles are enough to decide whether they would be worth clicking through.
docs/design/README.md
Outdated
| Binding patterns default to `let` bindings except inside a context where the | ||
| `var` keyword is used: | ||
|
|
||
| - The result of a `let` binding is the name is bound to an | ||
| [r-value](<https://en.wikipedia.org/wiki/Value_(computer_science)#lrvalue>). | ||
| This means the value can not be modified, and its address cannot be taken. | ||
| - A `var` binding has dedicated storage, and so the name is an | ||
| [l-value](<https://en.wikipedia.org/wiki/Value_(computer_science)#lrvalue>) | ||
| which can be modified and has a stable address. |
There was a problem hiding this comment.
OK, deferring this for now makes sense.
This follows #1274 . It mainly fills in the "generics" section, with smaller updates to other section. Co-authored-by: Chandler Carruth <chandlerc@gmail.com>
Reorganizes the sections, and makes a pass filling in and updating the first sections including: types, functions, user-defined types. The following sections are left for part 2, including names, generics, and interop. Also some smaller updates to, not revisiting the text: `pattern_matching.md`, `control_flow/return.md`, and `lexical_conventions/numeric_literals.md` Co-authored-by: Geoff Romer <gromer@google.com> Co-authored-by: Chandler Carruth <chandlerc@gmail.com>
This follows #1274 . It mainly fills in the "generics" section, with smaller updates to other section. Co-authored-by: Chandler Carruth <chandlerc@gmail.com>
This follows #1274 , #1325 , #1328 , #1336 , #1347 , and #1368 . This fills in details about how values work, value categories, parameter passing, unformed state, and so on. Co-authored-by: Geoff Romer <gromer@google.com> Co-authored-by: Richard Smith <richard@metafoo.co.uk> Co-authored-by: Chandler Carruth <chandlerc@gmail.com>
Reorganizes the sections, and makes a pass filling in and updating the first sections including: types, functions, user-defined types. The following sections are left for part 2, including names, generics, and interop.
Also some smaller updates to, not revisiting the text:
pattern_matching.md,control_flow/return.md, andlexical_conventions/numeric_literals.md