Skip to content

API Docs: net #29363

Closed
Closed
@steveklabnik

Description

@steveklabnik

Part of #29329

http://doc.rust-lang.org/std/net/

Here's what needs to be done to close out this issue:

  • the module documentation is very tiny and needs expanded.
  • ParseError needs to link to where it comes from and have examples.
  • Incoming should use the standard iterator boilerplate and move its semantics into the method docs.
  • Ipv4Addr needs better top-level docs and should link to IpAddr
  • many places in these docs should say "IETF RFC" rather than "RFC", as we have Rust RFCs as well.
  • Ipv6Addr same as Ipv4Addr.
  • SocketAddrV4 has poor top-level docs and needs to have a defined summary/explanation split. Its methods are okay, but very short. It needs to link to SocketAddr.
  • SocketAddrV6 same
  • TcpListener's docs don't really say what it is.
  • TcpStream's the same.
  • UpdSocket is the same.
  • IpAddr should link to an IETF RFC
  • Shutdown should use the standard boilerplate
  • SocketAddr has very short docs.
  • ToSocketAddrs needs a lot of links.

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsE-help-wantedCall for participation: Help is requested to fix this issue.E-mediumCall for participation: Medium difficulty. Experience needed to fix: Intermediate.E-mentorCall for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.P-mediumMedium priority

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions