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

Document experimental runtime API on docs.rs #1313

Closed
wants to merge 1 commit into from

Conversation

yuki0iq
Copy link
Contributor

@yuki0iq yuki0iq commented Feb 6, 2025

One can also use cargo docs-rs locally for viewing docs.

Closes #1180

One can also use `cargo docs-rs` locally for viewing docs.

Closes bytecodealliance#1180
@sunfishcode
Copy link
Member

I don't believe rustix::runtime is suitable to be stabilized and publicly documented on docs.rs in its current form. The safety conditions do not document what is required to use these APIs.

If you would like to see specific functions in rustix::runtime become publicly documented and stabilized, please bring them up for discussion.

@sunfishcode
Copy link
Member

Thinking about what rustix could do to help in this area, I've now posted these two items:

#1315 adds documentation for these functions, so that at least if someone is searching for them in the docs, they'll find more information.

I've now also filed #1314 to encourage people to post about functions in rustix::runtime that would be useful to publicly expose.

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.

Feature request: Document rustix::runtime
2 participants