doc: add comments for setter functions #34
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
KSXGitHub
reviewed
Aug 28, 2023
| @@ -234,6 +238,16 @@ impl Url { | |||
| unsafe { ffi::ada_get_href(self.0) }.as_str() | |||
| } | |||
|
|
|||
| /// Updates the href of the URL, and triggers the URL parser. | |||
| /// Returns true if operation is successful. | |||
There was a problem hiding this comment.
Yes, the URL specification contains certain edge cases.
There was a problem hiding this comment.
Then I think it is more idiomatic to return a Result<(), Error> instead. Error could be () if there is only one error variant.
For reference, the url crate provides various setter methods: https://docs.rs/url/2.4.1/url/struct.Url.html
(none of them are named set_href though)
There was a problem hiding this comment.
Makes sense. Would you like to open a pull request?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #29