Add syntax comment to \marginfig.

2025-07-29 22:27:11 -05:00
parent bee660efc2
commit 86c343532e
1 changed files with 13 additions and 0 deletions
--- a/MarginNotes.sty
+++ b/MarginNotes.sty
@@ -38,6 +38,19 @@
 	\RequirePackage{ifthen}

 	\newcommand{\marginfig}[5][0pt]{%
+		% Syntax:
+		% \marginfig[
+		%	vertical_offset
+		% ]{
+		%	graphic_file_name
+		% }{
+		%	(width|height)=lengthvalue
+		% }{
+		%	label
+		% }{
+		%	caption
+		% }
+		%
 		% This strut ensures that the margin figure is counted as part of the 
 		% following paragraph and is vertically aligned with it.
 		\strut%