add comments about errors #399
Open
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
|
This PR is stale because it has been open for 180 days with no activity. |
yuin
force-pushed
the
master
branch
5 times, most recently
from
e7e4266 to
a590622
Compare
|
This PR is stale because it has been open for 180 days with no activity. |
|
It won't break anything, I see no reason not to merge it in one-click :) |
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.
Hi, thanks for your valuable work!
I've spent some time guessing why
Convertmethod returns errors. My first guess was that the parser returns an error whenever it's unable to parse the input (which is strange). It turned out that the only possible cases for errors are:Writerimplementation returns an errorSo, in the default scenario there won't be any errors.
I've just highlighted these cases in the comments, so that future developers wouldn't have to spend time for guesswork.