Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: document uv.errno #620

Merged
merged 2 commits into from
Oct 14, 2022
Merged

docs: document uv.errno #620

merged 2 commits into from
Oct 14, 2022

Conversation

Bilal2453
Copy link
Contributor

documents changes introduced in a817184

Copy link
Member

@squeek502 squeek502 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for doing this!

- `ENOTTY`: inappropriate ioctl for device.
- `EFTYPE`: inappropriate file type or format.
- `EILSEQ`: illegal byte sequence.
- `ESOCKTNOSUPPORT`: socket type not supported.
Copy link
Member

@squeek502 squeek502 Oct 13, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it be better to just link out to https://docs.libuv.org/en/v1.x/errors.html#error-constants instead of enumerating them here? It would ensure that we wouldn't have to keep this list in sync.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Possibly, if it's autogenerated. It's nice to see the list here though too.

Copy link
Member

@squeek502 squeek502 Oct 13, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The errno table is populated using libuv's UV_ERRNO_MAP macro, so it'll always match the errors of version being built against.

Copy link
Contributor Author

@Bilal2453 Bilal2453 Oct 14, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was -and still am- debating whether we should just link that page or not. What I thought was "enumerating them here ain't gonna hurt", I guess we could do both, a link to the libuv docs page, while also listing them here (kinda nice to have em here in my opinion).

Does mean we will need to pay some attention to those values being updated, but to be honest that won't be happening that often, if at all.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good, I think adding the link would be good.

@squeek502 squeek502 merged commit 3496c0f into luvit:master Oct 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants