Skip to content

/rust-url

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 error documentation on parse function #379

Merged
merged 1 commit into from Jul 13, 2017

Conversation

Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
3 participants
@rap2hpoutre @SimonSapin @bors-servo
@rap2hpoutre
Copy link
Contributor

rap2hpoutre commented Jul 10, 2017 •
edited

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)

This change is Reviewable
@SimonSapin

This comment has been minimized.

Sign in to view
Copy link
Member

SimonSapin commented Jul 13, 2017

Looks good, thanks!

@bors-servo r+
@bors-servo

This comment has been minimized.

Sign in to view
Copy link
Contributor

bors-servo commented Jul 13, 2017

📌 Commit b8e1a95 has been approved by SimonSapin
@bors-servo

This comment has been minimized.

Sign in to view
Copy link
Contributor

bors-servo commented Jul 13, 2017

⌛️ Testing commit b8e1a95 with merge 8983fd9...

bors-servo added a commit that referenced this pull request Jul 13, 2017

@bors-servo
Auto merge of #379 - rap2hpoutre:master, r=SimonSapin 
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 -->
Loading status checks…
8983fd9
@bors-servo

This comment has been minimized.

Sign in to view
Copy link
Contributor

bors-servo commented Jul 13, 2017

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

@bors-servo bors-servo merged commit b8e1a95 into servo:master Jul 13, 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

@rap2hpoutre rap2hpoutre referenced this pull request Jul 17, 2017

Merged

add more documentation for errors #382

bors-servo added a commit that referenced this pull request Jul 17, 2017

@bors-servo
Auto merge of #382 - rap2hpoutre:master, r=SimonSapin 
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 -->
Loading status checks…
b8d3c15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.