Skip to content

Commit c782d87

Browse files
committed
docs(type annotations): did not update type annotations in repr docs for SheluaPipeInput
1 parent 57e71c9 commit c782d87

2 files changed

Lines changed: 10 additions & 5 deletions

File tree

REPR.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -173,20 +173,25 @@ Its result will be provided to the same run function as `single_stdin` would hav
173173
after adding the newly resolved values to the command result being resolved.
174174

175175
```lua
176-
---Will contain either `s`, a plain string,
177-
---or `c`, an input command string
178-
---@class Shelua.PipeInput
176+
---@class Shelua.PipeInputStdin
179177
---string stdin to combine
180178
---@field s? string|any
181179
---if string input came from a command,
182180
---`e` will contain a table of all other command result fields
183181
---such as `__exitcode`
184182
---@field e? table
183+
184+
---@class Shelua.PipeInputClass
185185
---cmd to combine
186186
---@field c? string|any
187187
---optional 2nd return of concat_cmd
188188
---@field m? any
189189

190+
---Will contain either `s`, a plain string,
191+
---or `c`, an input command string
192+
---@alias Shelua.PipeInput Shelua.PipeInputStdin | Shelua.PipeInputClass
193+
194+
190195
---strategy to combine piped inputs, 0, 1, or many, return resolved command to run
191196
---called only when proper_pipes is true
192197
---may return an optional second value to be placed in another PipeInput, or returned to run_cmd

lua/sh.lua

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
---Will contain either `s`, a plain string,
2-
---or `c`, an input command string
31
---@class Shelua.PipeInputStdin
42
---string stdin to combine
53
---@field s? string|any
@@ -14,6 +12,8 @@
1412
---optional 2nd return of concat_cmd
1513
---@field m? any
1614

15+
---Will contain either `s`, a plain string,
16+
---or `c`, an input command string
1717
---@alias Shelua.PipeInput Shelua.PipeInputStdin | Shelua.PipeInputClass
1818

1919
---@class Shelua.Repr

0 commit comments

Comments
 (0)