DOC: mdExporter

squadracorsepolito · May 19, 2024 · 83b712a · 83b712a
1 parent 457edd8
commit 83b712a
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/md_exporter.go b/md_exporter.go
@@ -9,6 +9,8 @@ import (
 	md "github.com/nao1215/markdown"
 )
 
+// ExportToMarkdown exports the given [Network] to a markdown document.
+// It writes the markdown document to the given [io.Writer].
 func ExportToMarkdown(network *Network, w io.Writer) error {
 	mdWriter := md.NewMarkdown(w)
 	exporter := newMDExporter(mdWriter)