Skip to content

Modify docs to put error conditions into Errors sections #314

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.

Sign up for GitHub

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

Jump to bottom
Closed
brson opened this issue May 4, 2017 · 5 comments
Closed

Modify docs to put error conditions into Errors sections #314

brson opened this issue May 4, 2017 · 5 comments

Comments

@brson
Copy link
Contributor

brson commented May 4, 2017

Per rust documentation RFC.
@brson brson added easy labels May 4, 2017
@brson brson mentioned this issue May 4, 2017
Closed
19 tasks
@llompartg
Copy link

Hey brson, first time contributing and really new to rust.

I would be happy to help out with this, is this still open? Also I'm afraid I'll need a bit of more info as per which RFC you mean and what exactly the needed changes are.

Thanks

@dtolnay
Copy link
Contributor

dtolnay commented May 12, 2017

@llompartg thanks, this is still open. He is referring to this guideline.

@brson
Copy link
Contributor Author

brson commented May 13, 2017

Awesome @llompartg! @dtolnay has the link.

Basically, every method that returns errors, instead of the error condition being described in the main body of the docs (or not described at all) there should be a section like

# Errors

Returns an error when...

@rap2hpoutre rap2hpoutre mentioned this issue Jul 10, 2017
Merged
@rap2hpoutre
Copy link
Contributor

rap2hpoutre commented Jul 10, 2017 •
edited
Loading

@llompartg I have just submitted a PR. If you still want to work on this issue, I can close it! (since there is no activity for a while now, so I thought I can submit something). As you want!

@brson I still need some mentoring, I'm not sure about my PR quality.

@behnam behnam closed this as completed Jul 10, 2017
@behnam behnam reopened this Jul 10, 2017
bors-servo pushed a commit that referenced this issue Jul 13, 2017
Auto merge of #379 - rap2hpoutre:master, r=SimonSapin
8983fd9 
Add error documentation on parse function

See: #314

This is just a try, feel free to close or comment if it's not good. I just submit one error documentation because I want to clearly understand what's the pattern before submitting more documentation: I still have to learn, so I prefer just trying on one function for now (but I can help after that)

<!-- Reviewable:start -->
---
This change is [<img src="https://reviewable.io/review_button.svg" height="34" align="absmiddle" alt="Reviewable"/>](https://reviewable.io/reviews/servo/rust-url/379)
<!-- Reviewable:end -->
@brson
Copy link
Contributor Author

brson commented Jul 15, 2017

@rap2hpoutre looks like your pr was merged. Thanks!

@brson brson closed this as completed Jul 15, 2017
@rap2hpoutre rap2hpoutre mentioned this issue Jul 18, 2017
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
6 participants
@behnam @brson @SimonSapin @rap2hpoutre @dtolnay @llompartg