Skip to content

Commit 4736df1

Browse files
committed
Add doc
1 parent 672e49d commit 4736df1

File tree

1 file changed

+27
-3
lines changed

1 file changed

+27
-3
lines changed

mathics/builtin/drawing/plot.py

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -762,7 +762,19 @@ class ColorDataFunction(Builtin):
762762

763763

764764
class ComplexPlot3D(_Plot3D):
765-
""" """
765+
"""
766+
<url>:WMA link: https://reference.wolfram.com/language/ref/ComplexPlot3D.html</url>
767+
<dl>
768+
<dt>'Plot3D'[$f$, {$z$, $z_{min}$, $z_{max}$}]
769+
<dd>creates a three-dimensional plot of the magnitude of $f$ with $z$ ranging from $z_{min}$ to \
770+
$z_{max}$ with surface colored according to phase
771+
772+
See <url>:Drawing Option and Option Values:
773+
/doc/reference-of-built-in-symbols/graphics-and-drawing/drawing-options-and-option-values
774+
</url> for a list of Plot options.
775+
</dl>
776+
777+
"""
766778

767779
summary_text = "plots one or more complex functions as a surface"
768780
expected_args = 2
@@ -774,9 +786,21 @@ class ComplexPlot3D(_Plot3D):
774786

775787

776788
class ComplexPlot(_Plot3D):
777-
""" """
789+
"""
790+
<url>:WMA link: https://reference.wolfram.com/language/ref/ComplexPlot.html</url>
791+
<dl>
792+
<dt>'Plot3D'[$f$, {$z$, $z_{min}$, $z_{max}$}]
793+
<dd>creates two-dimensional plot of $f$ with $z$ ranging from $z_{min}$ to \
794+
$z_{max}$ colored according to phase
795+
796+
See <url>:Drawing Option and Option Values:
797+
/doc/reference-of-built-in-symbols/graphics-and-drawing/drawing-options-and-option-values
798+
</url> for a list of Plot options.
799+
</dl>
800+
801+
"""
778802

779-
summary_text = "plots a complex function showing amplitude and phase using colors"
803+
summary_text = "plots a complex function showing phase using colors"
780804
expected_args = 2
781805
options = _Plot3D.options2d
782806

0 commit comments

Comments
 (0)