Merge pull request #3 from spekary/main

spekary · web-flow · commit c4061405c1b1 · 2022-03-16T19:56:16.000-07:00
Fixing some documentation
diff --git a/README.md b/README.md
@@ -16,6 +16,11 @@ html5tag does some checks to make sure tags are well-formed. For example,
 when adding data-* attributes, it will make sure the key used for the
 attribute does not violate html syntax rules.
 
+html5tag has options to pretty-print tags and the content of tags so they appear formatted
+in a document. However, in certain contexts, like in inline text, or in a textarea tag, adding
+extra returns and spaces changes the look of the output. In these situations, use the functions
+that do not add spaces to the inner HTML of a tag.
+
 Some examples:
 
 ```go
diff --git a/attributes.go b/attributes.go
@@ -743,9 +743,8 @@ func ValueString(i interface{}) string {
 	case bool:
 		if v {
 			return "" // boolean true
-		} else {
-			return FalseValue // Our special value to indicate to NOT print the attribute at all
 		}
+		return FalseValue // Our special value to indicate to NOT print the attribute at all
 	case string:
 		return v
 	case int:
diff --git a/class.go b/class.go
@@ -79,7 +79,7 @@ func RemoveWords(originalValues string, removeValues string) string {
 // Bootstrap uses 'col-lg-6' to represent a table that is 6 units wide on large screens and Foundation
 // uses 'large-6' to do the same thing. This utility removes classes that start with a particular prefix
 // to remove whatever sizing class was specified.
-// Returns the resulting class list, and true if the list actually changed.
+// Returns the resulting class list.
 func RemoveClassesWithPrefix(class string, prefix string) string {
 	classes := strings.Fields(class)
 	ret := ""
diff --git a/style.go b/style.go
@@ -142,8 +142,6 @@ func (s Style) SetChanged(property string, value string) (changed bool, err erro
 }
 
 // Set is like SetChanged, but returns the Style for chaining.
-//
-// It will also allocate a style if passed a nil style, and return it.
 func (s Style) Set(property string, value string) Style {
 	_, err := s.SetChanged(property, value)
 	if err != nil {
diff --git a/tag_test.go b/tag_test.go
@@ -18,9 +18,8 @@ func (b *errBuffer) Write(p []byte) (n int, err error) {
 		l := b.cap - b.buf.Len()
 		n, _ = b.Write(p[:l])
 		return n, fmt.Errorf("out of memory")
-	} else {
-		return b.buf.Write(p)
 	}
+	return b.buf.Write(p)
 }
 
 func newErrBuf(cap int) *errBuffer {

Original file line number	Diff line number	Diff line change
`@@ -142,8 +142,6 @@ func (s Style) SetChanged(property string, value string) (changed bool, err erro`
`142`	`142`	`}`
`143`	`143`
`144`	`144`	`// Set is like SetChanged, but returns the Style for chaining.`
`145`		`-//`
`146`		`-// It will also allocate a style if passed a nil style, and return it.`
`147`	`145`	`func (s Style) Set(property string, value string) Style {`
`148`	`146`	`_, err := s.SetChanged(property, value)`
`149`	`147`	`if err != nil {`
Original file line number	Diff line number	Diff line change
`@@ -18,9 +18,8 @@ func (b *errBuffer) Write(p []byte) (n int, err error) {`
`18`	`18`	`l := b.cap - b.buf.Len()`
`19`	`19`	`n, _ = b.Write(p[:l])`
`20`	`20`	`return n, fmt.Errorf("out of memory")`
`21`		`- } else {`
`22`		`- return b.buf.Write(p)`
`23`	`21`	`}`
	`22`	`+ return b.buf.Write(p)`
`24`	`23`	`}`
`25`	`24`
`26`	`25`	`func newErrBuf(cap int) *errBuffer {`