Skip to content

Commit

Permalink
feat(docs): update docs (#1005)
Browse files Browse the repository at this point in the history
feat(docs): update docs

Updates the Wing docs. See details in [workflow run].

[Workflow Run]: https://github.com/winglang/docsite/actions/runs/10742567472

------

*Automatically created via the "update-docs" workflow*
  • Loading branch information
monadabot authored Sep 6, 2024
1 parent 8015356 commit 2764a71
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -701,10 +701,10 @@ prepended to the unique identifier.
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#@winglang/sdk.std.IApp.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
| <code><a href="#@winglang/sdk.std.IApp.property.entrypointDir">entrypointDir</a></code> | <code>str</code> | The directory of the entrypoint of the current program. |
| <code><a href="#@winglang/sdk.std.IApp.property.entrypointDir">entrypointDir</a></code> | <code>str</code> | The directory of the entrypoint of the current Wing application. |
| <code><a href="#@winglang/sdk.std.IApp.property.isTestEnvironment">isTestEnvironment</a></code> | <code>bool</code> | `true` if this is a testing environment. |
| <code><a href="#@winglang/sdk.std.IApp.property.parameters">parameters</a></code> | <code><a href="#@winglang/sdk.platform.ParameterRegistrar">ParameterRegistrar</a></code> | The application's parameter registrar. |
| <code><a href="#@winglang/sdk.std.IApp.property.workdir">workdir</a></code> | <code>str</code> | The `.wing` directory into which you can emit artifacts during preflight. |
| <code><a href="#@winglang/sdk.std.IApp.property.workdir">workdir</a></code> | <code>str</code> | The `.wing` directory into which you can emit intermediate artifacts during preflight. |

---

Expand All @@ -728,7 +728,7 @@ entrypointDir: str;

- *Type:* str

The directory of the entrypoint of the current program.
The directory of the entrypoint of the current Wing application.

---

Expand Down Expand Up @@ -764,7 +764,7 @@ workdir: str;

- *Type:* str

The `.wing` directory into which you can emit artifacts during preflight.
The `.wing` directory into which you can emit intermediate artifacts during preflight.

---

8 changes: 5 additions & 3 deletions api_versioned_docs/version-latest/05-language-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -591,10 +591,12 @@ the following properties (given an example intrinsic `@x`):
| --------------- | ------------------------------------------------------------------------------------------------------------------------- |
| `@log()` | logs str |
| `@assert()` | checks a condition and _throws_ if evaluated to false |
| `@dirname` | current source directory |
| `@filename` | absolute path of the source file |
| `@dirname` | absolute path of the source file's directory |
| `@app` | the root of the construct tree |
| `@unsafeCast()` | cast a value into a different type |
| `@nodeof()` | obtain the [tree node](/docs/concepts/application-tree) of a preflight object |
| `@lift()` | explicitly qualify a [lift](/docs/concepts/inflights) of a preflight object |
| `@nodeof()` | obtain the [tree node](/docs/concepts/application-tree) of a preflight object |
| `@lift()` | explicitly qualify a [lift](/docs/concepts/inflights) of a preflight object |
> ```TS
> @log("Hello {name}");
Expand Down

0 comments on commit 2764a71

Please sign in to comment.