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 comments about errors #399

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

zakirullin
Copy link

Hi, thanks for your valuable work!

I've spent some time guessing why Convert method 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:

  1. Provided Writer implementation returns an error
  2. User-custom html renderers returns an error

So, 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant