Skip to content

Change crate docs to reflect new crate goals #74

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

Merged
3 commits merged into from
May 3, 2020

Conversation

Thomasdezeeuw
Copy link
Collaborator

If everyone agrees with these new goals:

  • Providing a minimal API around the libc/system calls.
  • Expose as much of the API as possible, possibly behind the all flag for API not available on all the (tier 1) OSes.

@Thomasdezeeuw Thomasdezeeuw requested review from alexcrichton and a user April 30, 2020 19:38
Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

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

Just a few typos -- this is a good clarification of the crate goals!

src/lib.rs Outdated
//!
//! This crate provides as direct as possible access to the system's
//! functionality for sockets as possible, this means **no** cross-platform
//! utilities, no extra goodies, no creature comforts. It is up to the user to
Copy link

Choose a reason for hiding this comment

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

Well... we do get plenty of cross-platform utilities as well as platform-specific options :) But I agree with the sentiment.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I've changed the wording a bit. Could you take another look?

If you ok with it I'll squash the commits and merge.

@ghost ghost merged commit 359d024 into rust-lang:master May 3, 2020
@Thomasdezeeuw Thomasdezeeuw deleted the doc-update branch May 3, 2020 17:55
This pull request was closed.
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.

2 participants