Add comments describing purpose of isBoldAndItalic

Author: Matthew Williams

claat/parser/md/html.go

@@ -61,6 +61,8 @@ func isItalic(hn *html.Node) bool {
 		hn.DataAtom == atom.I
 }
 
+// This is different to calling isBold and isItalic seperately as we must look
+// up an extra level in the tree
 func isBoldAndItalic(hn *html.Node) bool {
 	if hn.Parent == nil || hn.Parent.Parent == nil {
 		return false

claat/parser/md/parse.go

@@ -849,6 +849,7 @@ func link(ds *docState) types.Node {
 func text(ds *docState) types.Node {
 	bold := isBold(ds.cur)
 	italic := isItalic(ds.cur)
+	// We must call this to look up an extra level in the node tree to obtain both styles
 	if isBoldAndItalic(ds.cur) {
 		bold = true
 		italic = true