about summary refs log tree commit diff stats
path: root/gomponents.go
diff options
context:
space:
mode:
authorMarkus Wüstenberg2024-06-25 13:46:24 +0200
committerGitHub2024-06-25 13:46:24 +0200
commit1c0ceb44a530632be2d591eafcadea2ba481a682 (patch)
treeb61cc5295dd71ea337ed118a0834e81a80c3dd7d /gomponents.go
parentd9708f9290f723dd4424f86d300b18974e2c169b (diff)
downloadgomponents-1c0ceb44a530632be2d591eafcadea2ba481a682.tar.lz
gomponents-1c0ceb44a530632be2d591eafcadea2ba481a682.tar.zst
gomponents-1c0ceb44a530632be2d591eafcadea2ba481a682.zip
Adjust documentation on Iff (#179)
Diffstat (limited to 'gomponents.go')
-rw-r--r--gomponents.go10
1 files changed, 6 insertions, 4 deletions
diff --git a/gomponents.go b/gomponents.go
index ae7cadc..d93c8ae 100644
--- a/gomponents.go
+++ b/gomponents.go
@@ -254,8 +254,8 @@ func Group(children []Node) Node {
 
 // If condition is true, return the given Node. Otherwise, return nil.
 // This helper function is good for inlining elements conditionally.
-// If your condition and node involve a nilable variable, use iff because
-// go will evaluate the node regardless of the condition.
+// If it's important that the given Node is only evaluated if condition is true
+// (for example, when using nilable variables), use [Iff] instead.
 func If(condition bool, n Node) Node {
 	if condition {
 		return n
@@ -263,8 +263,10 @@ func If(condition bool, n Node) Node {
 	return nil
 }
 
-// Iff execute the function f if condition is true, otherwise return nil.
-// it is the preferred way to conditionally render a node if the node involves a nilable variable.
+// Iff condition is true, call the given function. Otherwise, return nil.
+// This helper function is good for inlining elements conditionally when the node depends on nilable data,
+// or some other code that could potentially panic.
+// If you just need simple conditional rendering, see [If].
 func Iff(condition bool, f func() Node) Node {
 	if condition {
 		return f()