Skip to content
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

fix(docs): Correct all occurrences of toml code blocks #3713

Merged
merged 7 commits into from
Nov 8, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/content/developer/getting-started/create-a-package.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The `Move.toml` file is the package's manifest. It describes the package and its
In `.toml` files, use the hash mark (`#`) to denote a comment.
:::

```toml file=<rootDir>/examples/move/first_package/Move.toml
```.toml file=<rootDir>/examples/move/first_package/Move.toml
```

:::tip Using a local version of IOTA
Expand All @@ -54,7 +54,7 @@ of the metadata.
The `[dependencies]` section specifies the dependencies of the project. The dependency specification can be a git
repository URL or a path to the local directory.

```toml file=<rootDir>/examples/move/first_package/Move.toml#L10-L15
```.toml file=<rootDir>/examples/move/first_package/Move.toml#L10-L15
```

Packages also import addresses from other packages. For example, the `Iota` dependency adds the `std` and `iota` addresses
Expand All @@ -66,7 +66,7 @@ If you have two dependencies that use different versions of the same package, yo
the `[dependencies]` section. To do so, add the `override` field to the dependency. The version specified in
the `[dependencies]` section will be used instead of the one specified in the dependency itself.

```toml file=<rootDir>/examples/move/first_package/Move.toml#L17-L19
```.toml file=<rootDir>/examples/move/first_package/Move.toml#L17-L19
```

### Dev-dependencies
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Previously a `published-at` entry was **mandatory** in the `Move.toml` file, whi
1. Delete the `published-at` line in your `Move.toml`.
1. Set your package's address to `0x0` in the `[addresses]` section. For example:

```toml
```.toml
[package]
name = "Kiosk"

Expand Down Expand Up @@ -69,7 +69,7 @@ This section is an overview of the schema and internal operation of tracked addr

A concrete example of the schema and state you might find in a `Move.lock` file:

```toml
```.toml
[env]

[env.testnet]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -369,7 +369,7 @@ and updates the `UpgradeCap` with the `UpgradeReceipt` after a successful upgrad
Let's walk through an example of developing and upgrading a package named `iota_package`.
Initially, your manifest might look like this:

```toml
```.toml
[package]
name = "iota_package"
version = "0.0.0"
Expand Down Expand Up @@ -499,7 +499,7 @@ Before executing the upgrade, you need to modify the package manifest:

Your updated manifest should look like this:

```toml
```.toml
[package]
name = "iota_package"
version = "0.0.1"
Expand Down Expand Up @@ -617,7 +617,7 @@ To reflect the new package ID, in the `[addresses]` section, return the `iota_pa
Your updated manifest should look like this:


```toml
```.toml
[package]
name = "iota_package"
version = "0.0.1"
Expand Down
2 changes: 1 addition & 1 deletion docs/content/developer/iota-101/objects/versioning.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ For instance, after upgrading from version 1 to 2, you can only upgrade from ver

Versioning also exists in package manifest files, both in the package section and the dependencies section. Consider the following example of manifest code:

```toml
```.toml
[package]
name = "some_pkg"
version = "1.0.0"
Expand Down
4 changes: 2 additions & 2 deletions docs/content/developer/iota-identity/getting-started/rust.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ To include IOTA Identity in your project, add it as a dependency in your `Cargo.

This version is published to crates.io and is **stable**, following semantic versioning.

```toml
```.toml
[dependencies]
identity_iota = { version = "1.2.0" }
```
Expand All @@ -33,7 +33,7 @@ identity_iota = { version = "1.2.0" }

This version matches the `main` branch of this repository. It has all the **latest features**, but as such, it **may also have undocumented breaking changes**.

```toml
```.toml
[dependencies]
identity_iota = { git = "https://github.com/iotaledger/identity.rs", branch = "main"}
```
Expand Down
2 changes: 1 addition & 1 deletion docs/content/references/move/move-lock.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ If you are using source control for your package, make sure the `Move.lock` file

When you build a package, the Move compiler resolves dependencies in `Move.toml`. After each resolution, the compiler writes the location of a dependency to the `Move.lock` file. If a dependency fails to resolve, the compiler stops writing to the `Move.lock` file and the build fails. If all dependencies resolve, the `Move.lock` file contains the locations (local and remote) of all your package's transitive dependencies. The `Move.lock` file stores the name and package details in an array similar to the following:

```toml
```.toml
[[move.dependency]]
name = “A”
source = { git = “https://github.com/b/c.git”, subdir = “e/f”, rev = “a1b2c3” }
Expand Down
4 changes: 2 additions & 2 deletions docs/content/references/move/move-toml.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The `[package]` section contains the following information:

The IOTA Move compiler creates the `[dependencies]` section for you with a single entry for the GitHub address of the IOTA network. If you need to use a local version of the network, you can edit the address to point to the local version. For example,

```toml
```.toml
IOTA = { local = "../crates/iota-framework" }
```

Expand All @@ -31,7 +31,7 @@ You place each additional dependency your package has on a new line directly bel

The IOTA Move compiler creates the `[addresses]` section for you with an entry for your package and one for the IOTA network.

```toml
```.toml
[addresses]
your_package_name = "0x0"
iota = "0000000000000000000000000000000000000000000000000000000000000002"
Expand Down
Loading