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

Add some documentation for Reader trait. #5659

Closed
wants to merge 0 commits into from

Conversation

steveklabnik
Copy link
Member

I saw #3317 go by, and figured I'd give it a bit of a start. I'd like some feedback on what I've done here before I try to document some more.

  1. I thought it'd be good to include example blocks even if there are no examples, gives a good marker for the future, and makes sure the markup stays pretty consistent between doc sections.
  2. All the usual details. Is my syntax correct? Descriptions fair? All the other stuff.

❤️ ❤️ ❤️

@brson
Copy link
Contributor

brson commented Apr 1, 2013

Looks good to me. Thanks for improving the docs.

@steveklabnik
Copy link
Member Author

Awesome. I'll work on some more of them for today, then.

This was referenced Apr 1, 2013
bors added a commit that referenced this pull request Apr 3, 2013
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?
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