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 more documentation for errors #382

Merged
merged 1 commit into from Jul 17, 2017
Merged

add more documentation for errors #382

merged 1 commit into from Jul 17, 2017

Conversation

@rap2hpoutre
Copy link
Contributor

rap2hpoutre commented Jul 17, 2017

More documentations for errors. See #314 and #379

Side question: I don't know how to document errors when a function returns Result<(), ()> so I did not document that part. I would be happy to see one example.


This change is Reviewable

@SimonSapin
Copy link
Member

SimonSapin commented Jul 17, 2017

Looks good, thanks!

@bors-servo r+


I don't know how to document errors when a function returns Result<(), ()>

Pretty much the same, except saying "returns an error" or "returns Err" without being more specific.

@bors-servo
Copy link
Contributor

bors-servo commented Jul 17, 2017

📌 Commit 053be60 has been approved by SimonSapin

@bors-servo
Copy link
Contributor

bors-servo commented Jul 17, 2017

Testing commit 053be60 with merge b8d3c15...

bors-servo added a commit that referenced this pull request Jul 17, 2017
add more documentation for errors

More documentations for errors.  See #319 and #379

_Side question: I don't know how to document errors when a function returns `Result<(), ()>` so I did not document that part. I would be happy to see one example._

<!-- 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/382)
<!-- Reviewable:end -->
@bors-servo
Copy link
Contributor

bors-servo commented Jul 17, 2017

☀️ Test successful - status-travis
Approved by: SimonSapin
Pushing b8d3c15 to master...

@bors-servo bors-servo merged commit 053be60 into servo:master Jul 17, 2017
3 checks passed
3 checks passed
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
homu Test successful
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants
You can’t perform that action at this time.