[move reference] Review new docs #35
Conversation
tnowacki
commented
Mar 29, 2024
tnowacki
commented
- Fixed prettier
- Fixed formatting
- Fixed small issues in new docs
| public fun borrow_mut<T>(s: &mut Matrix<T>, i: u64, j: u64): &mut T { | ||
| borrow_mut(borrow_mut(s.v, i), j) | ||
| public fun borrow_mut<T>(s: &mut Matrix<T>, i: u64, j: u64): &mut T { | ||
| vector::borrow_mut(vector::borrow_mut(&mut s.v, i), j) |
There was a problem hiding this comment.
| vector::borrow_mut(vector::borrow_mut(&mut s.v, i), j) | |
| &mut s.v[i][j] |
There was a problem hiding this comment.
Hmmmm, maybe? I was avoiding having to use index syntax to explain index syntax. Thoughts?
| public fun borrow<T>(s: &Matrix<T>, i: u64, j: u64): &T { | ||
| borrow(borrow(s.v, i), j) | ||
| public fun borrow<T>(s: &Matrix<T>, i: u64, j: u64): &T { | ||
| vector::borrow(vector::borrow(&s.v, i), j) |
There was a problem hiding this comment.
Is this better? It is more-likely what someone would write.
| vector::borrow(vector::borrow(&s.v, i), j) | |
| &s.v[i][j] |
| default: Value | ||
| ): &mut Value { | ||
| if (contains(input, *key)) { | ||
| if (contains(input, key)) { |
There was a problem hiding this comment.
Can we remove copy on Key if we write this as
| if (contains(input, key)) { | |
| if (contains(input, &key)) { |
There was a problem hiding this comment.
You could... but it would be annoying generally lol.
Take a look at the table API, all of the usages of Key are by-value because we lack life-time annotations. So the result would borrow both from the key and the table itself. The key is problematic particularly because the reference might be local
reference/src/packages.md
Outdated
| Most of the sections in the package manifest are self explanatory, but named addresses can be a bit | ||
| difficult to understand so we examine them in more detail in | ||
| [Named Addresses During Compilation](#named-addresses-during-compilation), but before that we'll | ||
| first take a look at the `Move.lock` file and what it contains. |
There was a problem hiding this comment.
IMO this is a confusion transition. I would consider swapping the two sections (since the lockfile doesn't appear to be mentioned in the address discussion) and rewrite this as:
Most of the sections in the package manifest should be self explanatory, with the exception of named addresses which are explained in the
next section. After being built, theMove.tomland configuration settings are stored in theMove.lockfile.
There was a problem hiding this comment.
I'll give it a shot!
There was a problem hiding this comment.
I like this a lot more than the current layout, so 👍🏻 from me on moving this section around.
reference/src/packages.md
Outdated
| `sui move <command> <command_flags>`. Unless a particular path is provided, all package commands | ||
| will run in the current working directory. The full list of commands and flags for the Move CLI can | ||
| be found by running `sui move --help`. |
There was a problem hiding this comment.
This seems a little unclear, because, e.g., sui move test will work at any directory in a package.
There was a problem hiding this comment.
Yea this is a great callout -- this should be something like (or similar)
... Unless a particular path is provided, all package commands will run in the current enclosing Move package. ....
reference/src/packages.md
Outdated
| With that, let's now turn to the compilation process and how named addresses are resolved, and how | ||
| to use them. |
There was a problem hiding this comment.
Will need to change this if we do the reordering
Co-authored-by: Cam Swords <[email protected]>
