Skip to content

Commit aff9981

Browse files
authored
Reword docs for manifest (slightly) (#1758)
1 parent c68aa3d commit aff9981

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

website/docs/reference/manifest.md

+16-14
Original file line numberDiff line numberDiff line change
@@ -76,11 +76,11 @@ If the edition field is not present in Scarb.toml, then the default edition is a
7676

7777
The publish field is an optional key that determines whether the package can be published to a registry.
7878
Setting this field to false will prevent the package from being published.
79-
If the publish field is not present, then it is assumed to be true.
79+
By default, this field is set to `true`.
8080

8181
```toml
8282
[package]
83-
publish = false
83+
publish = true
8484
```
8585

8686
### `cairo-version`
@@ -263,32 +263,34 @@ For example, while the Sierra name be `[6]`, with this flag turned on it might b
263263
- For types: `felt252` or `Box<Box<felt252>>`.
264264
- For user functions: `test::foo`.
265265

266+
By default, this flag is set to `false`.
267+
266268
```toml
267269
[cairo]
268-
sierra-replace-ids = true
270+
sierra-replace-ids = false
269271
```
270272

271273
### `allow-warnings`
272274

273275
If enabled, Scarb will not exit with error on compiler warnings.
274-
By default, this flag is enabled.
276+
By default, this flag is set to `true`.
275277

276278
```toml
277279
[cairo]
278-
allow-warnings = false
280+
allow-warnings = true
279281
```
280282

281283
### `enable-gas`
282284

283285
If enabled, during the project compilation Scarb will not add any instructions related to gas usage calculation.
284-
By default, this flag is enabled.
286+
By default, this flag is set to `true`.
285287

286288
```toml
287289
[cairo]
288-
enable-gas = false
290+
enable-gas = true
289291
```
290292

291-
This flag cannot be disabled while compiling the `starknet-contract` target.
293+
This flag cannot be set to `false` while compiling the `starknet-contract` target.
292294

293295
### `inlining-strategy`
294296

@@ -309,11 +311,11 @@ If `avoid` strategy is set, the compiler will only inline function annotated wit
309311
> It is advised not to use it for other purposes than that.
310312
311313
If enabled, during the project compilation Scarb will add redeposit gas libfunc calls in some locations.
312-
By default, this flag is disabled.
314+
By default, this flag is set to `false`.
313315

314316
```toml
315317
[cairo]
316-
add-redeposit-gas = true
318+
add-redeposit-gas = false
317319
```
318320

319321
### `unstable-add-statements-functions-debug-info`
@@ -327,11 +329,11 @@ add-redeposit-gas = true
327329
If enabled, during the project compilation Scarb will a add mapping between Sierra statement indexes and vectors of
328330
fully qualified paths of Cairo functions to debug info. A statement index maps to a vector consisting of a function
329331
which caused the statement to be generated and all functions that were inlined or generated along the way.
330-
By default, this flag is disabled.
332+
By default, this flag is set to `false`.
331333

332334
```toml
333335
[cairo]
334-
unstable-add-statements-functions-debug-info = true
336+
unstable-add-statements-functions-debug-info = false
335337
```
336338

337339
### `unstable-add-statements-code-locations-debug-info`
@@ -345,11 +347,11 @@ unstable-add-statements-functions-debug-info = true
345347
If enabled, during the project compilation Scarb will add a mapping between Sierra statement indexes and locations in
346348
the code to debug info. A statement index maps to a vector consisting of code fragment which caused the statement to be
347349
generated and all code fragments that were inlined or generated along the way.
348-
By default, this flag is disabled.
350+
By default, this flag is set to `false`.
349351

350352
```toml
351353
[cairo]
352-
unstable-add-statements-code-locations-debug-info = true
354+
unstable-add-statements-code-locations-debug-info = false
353355
```
354356

355357
## `[profile]`

0 commit comments

Comments
 (0)