Updating function and variable docs #1017
Conversation
There was a problem hiding this comment.
Definitely good to freshen all of this. Pulling in @wolffg explicitly here as he's been thinking about these high-level design concerns and may have wording or structure suggestions. It looks OK to me, but I also want to make sure this is working well for other readers as well. I have some comments inline too.
|
|
||
| <!-- tocstop --> | ||
|
|
||
| ## Overview |
There was a problem hiding this comment.
@zygoloid to ensure we're doing a decent job of introducing type inference and not missing any implications or connections to other parts of the language that we should establish...
Co-authored-by: Chandler Carruth <chandlerc@gmail.com>
docs/design/functions.md
Outdated
| A function declaration can be called, and the function definition may be | ||
| provided later in code; for example, the `api` file of a library will often | ||
| contain a function's declaration while the `impl` file contains the definition. |
There was a problem hiding this comment.
This seems a bit repetitive with things in the previous paragraph.
Co-authored-by: Richard Smith <richard@metafoo.co.uk>
Co-authored-by: Richard Smith <richard@metafoo.co.uk>
Co-authored-by: Richard Smith <richard@metafoo.co.uk>
| - For example, `fn Sleep(seconds: i64);` is similar to | ||
| `fn Sleep(seconds: i64) -> ();`. | ||
| - `()` is similar to a `void` return type in C++. | ||
|
|
There was a problem hiding this comment.
Perhaps state that switching between fn F(...) and fn F(...) -> () is a compatible change for all callers? (though the return statements in the function's definition would have to be updated)
There was a problem hiding this comment.
I'd suggest proposing this separately. There are two reasons I could see this not being true:
- It could be decided that
var x: auto = F()is either required or disallowed in some cases. - Constraints could be allowed to detect the difference.
In any case, I think this is a non-trivial decision and may be more appropriate for a proposal or its own change (this doc edit has already taken longer than I expected, I'd rather not push it out another couple weeks).
I was doing this for #851 initially, but I think #438 and #826 hadn't made it in (possibly intentionally due to #851? I don't recall). Feel free to comment on structure, I was trying to decide how best to approach this.