Skip to content

Commit 75af136

Browse files
committed
Go over constant docstrings.
1 parent e995426 commit 75af136

2 files changed

Lines changed: 19 additions & 21 deletions

File tree

mathics/builtin/constants.py

Lines changed: 18 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ class Catalan(MPMathConstant, NumpyConstant, SympyConstant):
156156
"""
157157
<dl>
158158
<dt>'Catalan'
159-
<dd>is Catalan's constant with numerical value about 0.915966
159+
<dd>is Catalan's constant with numerical value \u2243 0.915966.
160160
</dl>
161161
162162
>> Catalan // N
@@ -205,7 +205,7 @@ class Degree(MPMathConstant, NumpyConstant, SympyConstant):
205205
u"""
206206
<dl>
207207
<dt>'Degree'
208-
<dd>is the number of radians in one degree.
208+
<dd>is the number of radians in one degree. It hsas a numerical value of \u03c0 / 180.
209209
</dl>
210210
>> Cos[60 Degree]
211211
= 1 / 2
@@ -260,17 +260,15 @@ def apply_N(self, precision, evaluation):
260260

261261
class E(MPMathConstant, NumpyConstant, SympyConstant):
262262
"""
263-
, <dl>
264-
<dt>'E'
265-
<dd>is the constant e.
263+
<dl>
264+
<dt>'E'</dt>
265+
<dd>is the constant \u2147 with numerical value \u2243 2.71828.
266266
</dl>
267267
268268
>> N[E]
269269
= 2.71828
270270
>> N[E, 50]
271271
= 2.7182818284590452353602874713526624977572470937000
272-
>> Attributes[E]
273-
= {Constant, Protected, ReadProtected}
274272
275273
#> 5. E
276274
= 13.5914
@@ -286,10 +284,10 @@ def apply_N(self, precision, evaluation):
286284

287285

288286
class EulerGamma(MPMathConstant, NumpyConstant, SympyConstant):
289-
"""
287+
u"""
290288
<dl>
291-
<dt>'EulerGamma'
292-
<dd>is Euler's constant $y$ with numerial value around 0.577216.
289+
<dt>'EulerGamma'</dt>
290+
<dd>is Euler's constant \u03b3 with numerial value \u2243 0.577216.
293291
</dl>
294292
295293
>> EulerGamma // N
@@ -305,10 +303,10 @@ class EulerGamma(MPMathConstant, NumpyConstant, SympyConstant):
305303

306304

307305
class Glaisher(MPMathConstant):
308-
"""
306+
u"""
309307
<dl>
310-
<dt>'Glaisher'
311-
<dd>is Glaisher's constant, with numerical value about 1.28243.
308+
<dt>'Glaisher'</dt>
309+
<dd>is Glaisher's constant, with numerical value \u2243 1.28243.
312310
</dl>
313311
314312
>> N[Glaisher]
@@ -321,10 +319,10 @@ class Glaisher(MPMathConstant):
321319

322320

323321
class GoldenRatio(MPMathConstant, SympyConstant):
324-
"""
322+
u"""
325323
<dl>
326324
<dt>'GoldenRatio'
327-
<dd>is the golden ratio, Phi = (1+Sqrt[5])/2.
325+
<dd>is the golden ratio, \u03D5 = (1+Sqrt[5])/2.
328326
</dl>
329327
330328
>> GoldenRatio // N
@@ -340,7 +338,7 @@ class GoldenRatio(MPMathConstant, SympyConstant):
340338
class Indeterminate(SympyConstant):
341339
"""
342340
<dl>
343-
<dt>'Indeterminate'
341+
<dt>'Indeterminate'</dt>
344342
<dd>represents an indeterminate result.
345343
</dl>
346344
@@ -394,10 +392,10 @@ class Infinity(SympyConstant):
394392

395393

396394
class Khinchin(MPMathConstant):
397-
"""
395+
u"""
398396
<dl>
399-
<dt>'Khinchin'
400-
<dd>is Khinchin's constant, with numerical value aboug 2.68545.
397+
<dt>'Khinchin'</dt>
398+
<dd>is Khinchin's constant, with numerical value \u2243 2.68545.
401399
</dl>
402400
403401
>> N[Khinchin]
@@ -412,7 +410,7 @@ class Khinchin(MPMathConstant):
412410
class Pi(MPMathConstant, SympyConstant):
413411
"""
414412
<dl>
415-
<dt>'Pi'
413+
<dt>'Pi'</dt>
416414
<dd>is the constant \u03c0.
417415
</dl>
418416

mathics/builtin/linalg.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -692,7 +692,7 @@ class Eigenvalues(Builtin):
692692
<dl>
693693
<dt>'Eigenvalues[$m$]'
694694
<dd>computes the eigenvalues of the matrix $m$.
695-
By default Sympy's routine is used. Sometiems this is slow and
695+
By default Sympy's routine is used. Sometimes this is slow and
696696
less good than the corresponding mpmath routine. Use option Method->"mpmath" if you want
697697
to use mpmath's routine instead.
698698
</dl>

0 commit comments

Comments
 (0)