-
Notifications
You must be signed in to change notification settings - Fork 12.8k
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
Improve documentation for core::io. #5673
Conversation
|
|
I think the sections for examples should be left out until there are actually examples - I don't think we'll ever end up adding examples for every single function. |
I plan on doing it. It's going to take a while, but good examples are the difference between good docs and amazing docs. |
I think that there wouldn't be any need for examples if there was the ability to reference test functions: there are test functions for each function and they essentially show how to use them, what is the output and when they fail. |
Examples written with the intent of documenting the functions are going to be much better than code written to test them. I just don't like the placeholders. |
This should fix the build error. |
When I submitted #5659, it apparently caused some test failures. Then, because I left it in my incoming rather than making a new branch, I deleted my commit. Let's try this again, this time, with its own branch so that I don't screw it up. r?
Add regression test for endless loop / update `pulldown_cmark` Closes rust-lang#4917 This was fixed in pulldown_cmark 0.7.1, specifically pulldown-cmark/pulldown-cmark#438 changelog: none
When I submitted #5659, it apparently caused some test failures. Then, because I left it in my incoming rather than making a new branch, I deleted my commit.
Let's try this again, this time, with its own branch so that I don't screw it up.
r?