Merge 7c7149f93c into 04410ff159

README.md

@@ -77,7 +77,7 @@ Convert Markdown documents with the CommonMark-compliant mode:
 ```go
 var buf bytes.Buffer
 if err := goldmark.Convert(source, &buf); err != nil {
-  panic(err)
+  panic(err) // errors won't occur with in-memory buffer and default html renderers
 }
 ```
 

markdown.go

@@ -28,6 +28,7 @@ var defaultMarkdown = New()
 
 // Convert interprets a UTF-8 bytes source in Markdown and
 // write rendered contents to a writer w.
+// Errors are reported as per the Writer interface and provided renderers.
 func Convert(source []byte, w io.Writer, opts ...parser.ParseOption) error {
 	return defaultMarkdown.Convert(source, w, opts...)
 }
@@ -37,6 +38,7 @@ func Convert(source []byte, w io.Writer, opts ...parser.ParseOption) error {
 type Markdown interface {
 	// Convert interprets a UTF-8 bytes source in Markdown and write rendered
 	// contents to a writer w.
+	// Errors are reported as per the Writer interface and provided renderers.
 	Convert(source []byte, writer io.Writer, opts ...parser.ParseOption) error
 
 	// Parser returns a Parser that will be used for conversion.