nim: add comment to explain the option

[arcathrax (via pkgsrc-wip) <commit-notify%pkgsrc.org@localhost>]

Module Name:	pkgsrc-wip
Committed By:	arcathrax <ivan%ivanpollak.com@localhost>
Pushed By:	arcathrax
Date:		Mon Nov 2 19:52:10 2026 +0100
Changeset:	b31574378ac1257e072fac38daeac443b2cb608c

Modified Files:
	nim/options.mk

Log Message:
nim: add comment to explain the option

To see a diff of this commit:
https://wip.pkgsrc.org/cgi-bin/gitweb.cgi?p=pkgsrc-wip.git;a=commitdiff;h=b31574378ac1257e072fac38daeac443b2cb608c

Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.

diffstat:
 nim/options.mk | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diffs:
diff --git a/nim/options.mk b/nim/options.mk
index bdd3cfcd02..2d2b828721 100644
--- a/nim/options.mk
+++ b/nim/options.mk
@@ -4,9 +4,13 @@ PKG_SUGGESTED_OPTIONS=
 
 .include "../../mk/bsd.options.mk"
 
+# This will build the documentation for nim. Because both post-build and
+# post-install are not defined prior to this, we can safely just initialize
+# them here. Note that to build the documentation, NodeJS is needed, which
+# is quite large.
 .if !empty(PKG_OPTIONS:Mdoc)
-
 .include "../../lang/nodejs/buildlink3.mk"
+
 USE_LANGUAGES+=	c++
 PLIST_SRC+=			PLIST
 PLIST_SRC+=			PLIST.doc
@@ -21,4 +25,5 @@ post-install:
 	# Copy over docs to ${DESTDIR}
 	${MKDIR} -p ${DESTDIR}${PREFIX}/share/doc/nim
 	cd ${WRKSRC} && ${CP} -r doc/html/* ${DESTDIR}${PREFIX}/share/doc/nim
+
 .endif