[move] Add example of user code organized into multiple packages #5676
Conversation
|
The example looks good! We should likely document it here as well. I'll leave it to @randall-Mysten to give the final stamp from a docs perspective. |
| An example of how to structure your code to include another user-level package as a dependency. | ||
|
|
||
| The main things to pay attention to is to make sure that the dependency name (in this example | ||
| DepPackage in main_package/Move.toml file's `[dependency]` section) is the same as the name of the |
There was a problem hiding this comment.
is the same as the name of the
package (in dep_package/Move.toml file's [package] section) are exactly the same
seems redundant - make sure that the dep name is the same as the name of the package (...) are exactly the same...
| @@ -0,0 +1,5 @@ | |||
| An example of how to structure your code to include another user-level package as a dependency. | |||
|
|
|||
| The main things to pay attention to is to make sure that the dependency name (in this example | |||
There was a problem hiding this comment.
| The main things to pay attention to is to make sure that the dependency name (in this example | |
| The main things to pay attention to are to make sure that the dependency name (in this example |
There was a problem hiding this comment.
it sounds like there is only 1 thing to pay attention to?
What if it said "Make sure that the dependency name in this example"
| An example of how to structure your code to include another user-level package as a dependency. | ||
|
|
||
| The main things to pay attention to is to make sure that the dependency name (in this example | ||
| DepPackage in main_package/Move.toml file's `[dependency]` section) is the same as the name of the |
There was a problem hiding this comment.
| DepPackage in main_package/Move.toml file's `[dependency]` section) is the same as the name of the | |
| DepPackage in main_package/Move.toml file's `[dependencies]` section) is the same as the name of the |
There was a problem hiding this comment.
why is this in brackets?
There was a problem hiding this comment.
It is referring to the syntax in TOML files where table (key-value section) headers are denoted by square brackets.
|
|
||
| The main things to pay attention to is to make sure that the dependency name (in this example | ||
| DepPackage in main_package/Move.toml file's `[dependency]` section) is the same as the name of the | ||
| package (in dep_package/Move.toml file's `[package]` section) are exactly the same |
There was a problem hiding this comment.
| package (in dep_package/Move.toml file's `[package]` section) are exactly the same | |
| package (in dep_package/Move.toml file's `[package]` section). |
|
Thank you for the comments and suggestions @amnn and @randall-Mysten. And sorry for the sloppy writing (among other things, started thinking that there would be more things to pay attention to and this never materialized but artifacts remained...) |
Thanks for updating the docs. Happy to partner on this earlier in the process so we can iterate and fine-tune before creating the PR. |
This resolves #5517 by providing an example on how to structure user code with multiple packages.