Skip to content

Documentation in std::net lacks description of possible error values #46274

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

Closed
torkleyy opened this issue Nov 26, 2017 · 3 comments
Closed

Documentation in std::net lacks description of possible error values #46274

torkleyy opened this issue Nov 26, 2017 · 3 comments
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools C-enhancement Category: An issue proposing an enhancement or a PR with one. E-medium Call for participation: Medium difficulty. Experience needed to fix: Intermediate. P-medium Medium priority

Comments

@torkleyy
Copy link

For many methods it's unclear for which reason a method could fail, e.g. TcpStream::try_clone. An Errors section would be very helpful for these methods.

@fhartwig
Copy link
Contributor

Related: #45536

@TimNN TimNN added C-enhancement Category: An issue proposing an enhancement or a PR with one. A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools labels Nov 28, 2017
@steveklabnik steveklabnik added the E-medium Call for participation: Medium difficulty. Experience needed to fix: Intermediate. label May 29, 2018
@steveklabnik steveklabnik added the P-medium Medium priority label Dec 27, 2018
@DevQps
Copy link
Contributor

DevQps commented Aug 9, 2019

@steveklabnik I am not sure, but I think we can close this one for the following reasons:

  1. It's not clear when try_clone calls can fail #45536 more or less already covers try_clone method specifically.
  2. If this issue intended to cover Errors of the entire std, it's probably a bit too broad for an issue.

There are already some other issues around for adding potential errors for specific std submodules. Let me know if you agree! Otherwise we can maybe try to think towards a managable solution!

@steveklabnik
Copy link
Member

Yep, I agree completely. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools C-enhancement Category: An issue proposing an enhancement or a PR with one. E-medium Call for participation: Medium difficulty. Experience needed to fix: Intermediate. P-medium Medium priority
Projects
None yet
Development

No branches or pull requests

5 participants