Skip to content

Commit 150669e

Browse files
committed
more formatting
1 parent eab9254 commit 150669e

File tree

7 files changed

+41
-30
lines changed

7 files changed

+41
-30
lines changed

.trunk/configs/.markdownlint.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"line-length": { "line_length": 100 },
2+
"line-length": { "line_length": 150, "tables": false },
33
"no-inline-html": false,
44
"no-bare-urls": false,
55
"no-space-in-emphasis": false

modus/app-manifest.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ the full URL in the `endpoint` field.
169169
</Note>
170170

171171
<ResponseField name="headers" type="object">
172-
If provided, requests on the connection include these headers. Each key-value pair is a header name and value.
172+
If provided, requests on the connection include these headers. Each key-value pair is a header name and value.
173173

174174
Values may include variables using the `{{VARIABLE}}` template syntax, which resolve at runtime to
175175
secrets provided for each connection, via the Hypermode Console.

modus/quickstart.mdx

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ Modus app and how to run it locally.
1818

1919
<Steps>
2020
<Step title="Install the Modus CLI">
21-
The Modus CLI provides a set of commands to help you create, build, and run your Modus apps. You can
22-
install the CLI using cURL or npm.
21+
The Modus CLI provides a set of commands to help you create, build, and run your Modus apps.
22+
You can install the CLI using cURL or npm.
2323

2424
<CodeGroup>
2525

@@ -58,7 +58,8 @@ Modus app and how to run it locally.
5858

5959
</Step>
6060
<Step title="Add a connection">
61-
Modus is a secure-by-default framework. To connect to external services, you need to add a connection in your app manifest.
61+
Modus is a secure-by-default framework. To connect to external services, you need to add a connection
62+
in your app manifest.
6263

6364
Add the following code into your `modus.json` manifest file:
6465

@@ -75,7 +76,8 @@ Modus app and how to run it locally.
7576

7677
</Step>
7778
<Step title="Add a function">
78-
Functions are the building blocks of your app. Let's add a function that fetches a random quote from the ZenQuotes connection you just created.
79+
Functions are the building blocks of your app. Let's add a function that fetches a random quote from
80+
the ZenQuotes connection you just created.
7981

8082
<Tabs>
8183
<Tab title="Go">
@@ -147,7 +149,8 @@ Modus app and how to run it locally.
147149
}
148150
```
149151

150-
Then add the following to `index.ts`. This includes the `getRandomQuote` function on your generated API.
152+
Then add the following to `index.ts`. This includes the `getRandomQuote` function on
153+
your generated API.
151154

152155
```ts index.ts
153156
export { getRandomQuote } from "./quotes";

modus/sdk/graphql.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,9 @@ graphql.execute<T> (
4848
```
4949

5050
<ResponseField name="T" type="Type" required>
51-
Type of object to use for the data returned from the query. This can be any type, including a custom type defined in your project. It should match the shape of the data returned from the GraphQL query.
51+
52+
Type of object to use for the data returned from the query. This can be any type, including a custom type
53+
defined in your project. It should match the shape of the data returned from the GraphQL query.
5254

5355
<Tip>
5456
Define custom types in the project's source code. In AssemblyScript, create classes decorated with `@json`.

modus/sdk/models.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,8 +154,9 @@ Information about a model that's used to construct a `Model` instance. It's also
154154
property on the `Model` class.
155155

156156
<Info>
157-
This class relays information from the Modus runtime to the model implementation. Generally, you don't need to
158-
create `ModelInfo` instances directly.
157+
158+
This class relays information from the Modus runtime to the model implementation. Generally, you
159+
don't need to create `ModelInfo` instances directly.
159160

160161
However, if you are implementing a custom model, you may wish to use a property from this class,
161162
such as the `fullName`, for model providers that require the model name in the input request body.

modus/sdk/postgresql.mdx

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -65,9 +65,9 @@ function postgresql.execute (
6565
SQL statement containing the query or mutation operation to execute.
6666

6767
<Warning>
68-
While it's possible to directly include parameter values into your SQL statement, it's highly recommended to pass a
69-
[`Params`](#params) object instead. This can help to prevent against injection attacks and other security
70-
vulnerabilities.
68+
While it's possible to directly include parameter values into your SQL statement, it's
69+
highly recommended to pass a [`Params`](#params) object instead. This can help to prevent
70+
against injection attacks and other security vulnerabilities.
7171
</Warning>
7272
</ResponseField>
7373

@@ -92,7 +92,8 @@ function postgresql.query<T>(
9292
```
9393

9494
<ResponseField name="T" type="Type" required>
95-
Type of object to use for the data returned from the query. This can be any type, including a custom type defined in your project. It should match the shape of the row returned from the SQL query.
95+
Type of object to use for the data returned from the query. This can be any type, including a custom
96+
type defined in your project. It should match the shape of the row returned from the SQL query.
9697

9798
<Tip>
9899
Define custom types in the app's source code. In AssemblyScript, create classes decorated with `@json`.
@@ -114,9 +115,9 @@ If working with PostgreSQL's `point` data type, you can use a [`Point`](#point)
114115
SQL statement containing the query or mutation operation to execute.
115116

116117
<Warning>
117-
While it's possible to directly include parameter values into your SQL statement, it's highly recommended to pass a
118-
[`Params`](#params) object instead. This can help to prevent against injection attacks and other security
119-
vulnerabilities.
118+
While it's possible to directly include parameter values into your SQL statement, it's highly
119+
recommended to pass a [`Params`](#params) object instead. This can help to prevent against
120+
injection attacks and other security vulnerabilities.
120121
</Warning>
121122
</ResponseField>
122123

@@ -154,9 +155,9 @@ function postgresql.queryScalar<T> (
154155
SQL statement containing the query or mutation operation to execute.
155156

156157
<Warning>
157-
While it's possible to directly include parameter values into your SQL statement, it's highly recommended to pass a
158-
[`Params`](#params) object instead. This can help to prevent against injection attacks and other security
159-
vulnerabilities.
158+
While it's possible to directly include parameter values into your SQL statement, it's highly
159+
recommended to pass a [`Params`](#params) object instead. This can help to prevent against
160+
injection attacks and other security vulnerabilities.
160161
</Warning>
161162
</ResponseField>
162163

@@ -185,8 +186,9 @@ want to include. Then pass the object to the `execute`, `query`, or `queryScalar
185186
with your SQL statement.
186187

187188
<ResponseField name="push(value)">
188-
Push a parameter value into the list included with the SQL operation. The sequence of calls to `push` determines the
189-
order of the parameters in the SQL statement. This corresponds to the order of the `?` placeholders or `$1`, `$2`, etc.
189+
Push a parameter value into the list included with the SQL operation. The sequence of calls to
190+
`push` determines the order of the parameters in the SQL statement. This corresponds to the order
191+
of the `?` placeholders or `$1`, `$2`, etc.
190192

191193
<ResponseField name="value" type="any" required>
192194
The value of the parameter to include in the SQL operation.

quickstart.mdx

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,8 @@ to deploy it to Hypermode.
2323
intelligent functions and APIs, powered by WebAssembly. With Hypermode, you can deploy,
2424
secure, and observe your Modus apps.
2525

26-
To get started, [create your first Modus app](/modus/quickstart). You can import this app into Hypermode in the next step.
26+
To get started, [create your first Modus app](/modus/quickstart). You can import this app into
27+
Hypermode in the next step.
2728

2829
</Step>
2930
<Step title="Import Modus app">
@@ -45,20 +46,22 @@ to deploy it to Hypermode.
4546
npm install -g @hypermode/hyp
4647
```
4748
</CodeGroup>
48-
From the terminal, run the following command to import your Modus app into Hypermode. This command will create your Hypermode project and deploy your app.
49+
From the terminal, run the following command to import your Modus app into Hypermode. This command
50+
will create your Hypermode project and deploy your app.
4951

5052
```bash
5153
hyp init
5254
```
5355
</Tab>
5456
</Tabs>
5557

56-
When Hypermode creates your project, a runtime is initiated for your app as well as connections to any [Hypermode-hosted models](/hosted-models).
58+
When Hypermode creates your project, a runtime is initiated for your app as well as connections to
59+
any [Hypermode-hosted models](/hosted-models).
5760

5861
</Step>
5962
<Step title="Explore API endpoint">
60-
After deploying your app, Hypermode lands you in your project home. You can see the status of your project
61-
and the API endpoint generated for your app.
63+
After deploying your app, Hypermode lands you in your project home. You can see the status of your
64+
project and the API endpoint generated for your app.
6265

6366
From the **Query** page, you can run a sample query to verify it's working as expected. In the following
6467
query, we're going to use the `generateText` function to generate text from the shared Meta Llama
@@ -79,9 +82,9 @@ to deploy it to Hypermode.
7982
</Step>
8083
<Step title="Observe function execution">
8184
Let's dig deeper into the behavior of our AI service when we ran the query by looking at the
82-
**Inferences** page. You can see the step-by-step inference process and the inputs and outputs of the
83-
model at each step of your function. We can see in this case, it took Llama 4.4 seconds to reply to the prompt. We
84-
can also see the parameters on both the inputs and outputs.
85+
**Inferences** page. You can see the step-by-step inference process and the inputs and outputs of
86+
the model at each step of your function. We can see in this case, it took Llama 4.4 seconds to
87+
reply to the prompt. We can also see the parameters on both the inputs and outputs.
8588

8689
```json
8790
{

0 commit comments

Comments
 (0)