Skip to content

Commit

Permalink
docs: most new_handle methods won't return fail
Browse files Browse the repository at this point in the history
  • Loading branch information
Bilal2453 authored Dec 14, 2023
1 parent 3e55ac4 commit 5cf1269
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -779,7 +779,7 @@ end)
Creates and initializes a new `uv_prepare_t`. Returns the Lua userdata wrapping
it.

**Returns:** `uv_prepare_t userdata` or `fail`
**Returns:** `uv_prepare_t userdata`

### `uv.prepare_start(prepare, callback)`

Expand Down Expand Up @@ -825,7 +825,7 @@ end)
Creates and initializes a new `uv_check_t`. Returns the Lua userdata wrapping
it.

**Returns:** `uv_check_t userdata` or `fail`
**Returns:** `uv_check_t userdata`

### `uv.check_start(check, callback)`

Expand Down Expand Up @@ -878,7 +878,7 @@ end)
Creates and initializes a new `uv_idle_t`. Returns the Lua userdata wrapping
it.

**Returns:** `uv_idle_t userdata` or `fail`
**Returns:** `uv_idle_t userdata`

### `uv.idle_start(idle, callback)`

Expand Down Expand Up @@ -1783,7 +1783,7 @@ Creates and initializes a new `uv_pipe_t`. Returns the Lua userdata wrapping
it. The `ipc` argument is a boolean to indicate if this pipe will be used for
handle passing between processes.

**Returns:** `uv_pipe_t userdata` or `fail`
**Returns:** `uv_pipe_t userdata`

### `uv.pipe_open(pipe, fd)`

Expand Down Expand Up @@ -2431,7 +2431,7 @@ handle uses the best backend for the job on each platform.
Creates and initializes a new `uv_fs_event_t`. Returns the Lua userdata wrapping
it.

**Returns:** `uv_fs_event_t userdata` or `fail`
**Returns:** `uv_fs_event_t userdata`

### `uv.fs_event_start(fs_event, path, flags, callback)`

Expand Down Expand Up @@ -2487,7 +2487,7 @@ they can work on file systems where fs event handles can't.
Creates and initializes a new `uv_fs_poll_t`. Returns the Lua userdata wrapping
it.

**Returns:** `uv_fs_poll_t userdata` or `fail`
**Returns:** `uv_fs_poll_t userdata`

### `uv.fs_poll_start(fs_poll, path, interval, callback)`

Expand Down Expand Up @@ -3330,7 +3330,7 @@ a Lua function or a string containing Lua code or bytecode dumped from a functio
are passed to the `entry` function and an optional `options` table may be
provided. Currently accepted `option` fields are `stack_size`.

**Returns:** `luv_thread_t userdata` or `fail`
**Returns:** `luv_thread_t userdata`

**Note:** unsafe, please make sure the thread end of life before Lua state close.

Expand Down

0 comments on commit 5cf1269

Please sign in to comment.