Skip to content

Commit

Permalink
Merge pull request #703 from adigitoleo/fix-fs-mode-docs
Browse files Browse the repository at this point in the history
docs: Clarify types for mode arg in some filesystem functions
  • Loading branch information
squeek502 committed Jun 3, 2024
2 parents 7233e6d + 78351b6 commit b32cc4d
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -2591,7 +2591,7 @@ Equivalent to `close(2)`.
**Parameters:**
- `path`: `string`
- `flags`: `string` or `integer`
- `mode`: `integer`
- `mode`: `integer` (octal `chmod(1)` mode, e.g. `tonumber('644', 8)`)
- `callback`: `callable` (async version) or `nil` (sync version)
- `err`: `nil` or `string`
- `fd`: `integer` or `nil`
Expand Down Expand Up @@ -2666,7 +2666,7 @@ If `offset` is nil or omitted, it will default to `-1`, which indicates 'use and

**Parameters:**
- `path`: `string`
- `mode`: `integer`
- `mode`: `integer` (octal `chmod(1)` mode, e.g. `tonumber('755', 8)`)
- `callback`: `callable` (async version) or `nil` (sync version)
- `err`: `nil` or `string`
- `success`: `boolean` or `nil`
Expand Down Expand Up @@ -2897,7 +2897,7 @@ Limited equivalent to `sendfile(2)`. Returns the number of bytes written.

**Parameters:**
- `path`: `string`
- `mode`: `integer`
- `mode`: `string` (a combination of the `'r'`, `'w'` and `'x'` characters denoting the symbolic mode as per `chmod(1)`)
- `callback`: `callable` (async version) or `nil` (sync version)
- `err`: `nil` or `string`
- `permission`: `boolean` or `nil`
Expand All @@ -2914,7 +2914,7 @@ Returns `true` or `false` indicating access permission.

**Parameters:**
- `path`: `string`
- `mode`: `integer`
- `mode`: `integer` (octal `chmod(1)` mode, e.g. `tonumber('644', 8)`)
- `callback`: `callable` (async version) or `nil` (sync version)
- `err`: `nil` or `string`
- `success`: `boolean` or `nil`
Expand Down

0 comments on commit b32cc4d

Please sign in to comment.