Skip to content

Commit be94f1e

Browse files
govindkavaturi-artGk
andauthored
docs(readme): remove em dashes (#8)
Co-authored-by: Gk <gk@Gks-MacBook-Pro.local>
1 parent 3fffd2d commit be94f1e

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ const step = defineStep({
166166

167167
### 5. Structured Failures
168168

169-
Pipelines return `Result<T>` either success with a value, or a structured failure identifying exactly what went wrong.
169+
Pipelines return `Result<T>`: either success with a value, or a structured failure identifying exactly what went wrong.
170170

171171
```typescript
172172
const result = await myPipeline.run(input)
@@ -218,10 +218,10 @@ When a step fails, the `Failure` object contains the raw `input`, `output`, and
218218
const result = await myPipeline.run(input)
219219

220220
if (!result.ok) {
221-
// Internal logging full context
221+
// Internal logging: full context
222222
logger.debug('Pipeline failure', result.failure)
223223

224-
// User-facing redact raw data
224+
// User-facing: redact raw data
225225
const safeError = {
226226
step: result.failure.step,
227227
reason: result.failure.reason,
@@ -239,7 +239,7 @@ A pipeline-level `onFailure` redaction hook is planned for v0.2.
239239

240240
Cuechain verifies contracts between steps. [CueAPI](https://cueapi.ai) verifies outcomes against reality. Use one, use both.
241241

242-
**Standalone Cuechain:** run a contract-verified pipeline from any trigger — a button click, an HTTP handler, a test, a local script. No infrastructure required.
242+
**Standalone Cuechain:** run a contract-verified pipeline from any trigger. A button click, an HTTP handler, a test, a local script. No infrastructure required.
243243

244244
**Standalone CueAPI:** schedule a cue that fires a webhook. The handler does whatever it wants internally. No Cuechain required.
245245

@@ -279,7 +279,7 @@ Create a pipeline builder. Chain `.step()` to add steps.
279279

280280
### `Pipeline.run(input)`
281281

282-
Returns `Result<T>` `{ ok: true, value }` or `{ ok: false, failure }`.
282+
Returns `Result<T>`: `{ ok: true, value }` or `{ ok: false, failure }`.
283283

284284
### `Pipeline.runOrThrow(input)`
285285

0 commit comments

Comments
 (0)