Skip to content

Commit 87e278b

Browse files
authored
More on complete documentation (#989)
Adding docstrings to modules that otherwise would not be loaded in the documentation. The part of #987 which is related to the builtin modules.
1 parent da38eb7 commit 87e278b

File tree

5 files changed

+24
-3
lines changed

5 files changed

+24
-3
lines changed

mathics/builtin/compress.py

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# -*- coding: utf-8 -*-
2-
2+
"""
3+
Compress Functions
4+
"""
35

46
import base64
57
import zlib

mathics/builtin/forms/base.py

+2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
form_symbol_to_class = {}
66

7+
no_doc = "no doc"
8+
79

810
class FormBaseClass(Builtin):
911
"""

mathics/builtin/forms/variables.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""
2-
Form variables
2+
Form Variables
33
44
"""
55

mathics/builtin/inference.py

+4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# -*- coding: utf-8 -*-
2+
"""
3+
Inference Functions
4+
"""
25

6+
no_doc = "no doc"
37

48
from mathics.core.expression import Expression
59
from mathics.core.parser import parse_builtin_rule

mathics/builtin/intfns/misc.py

+14-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
# -*- coding: utf-8 -*-
2+
3+
"""
4+
Miscelanea of Integer Functions
5+
"""
6+
7+
18
from mathics.core.attributes import A_LISTABLE, A_PROTECTED
29
from mathics.core.builtin import MPMathFunction
310

@@ -20,7 +27,13 @@ class BernoulliB(MPMathFunction):
2027
First five Bernoulli numbers:
2128
2229
>> Table[BernoulliB[k], {k, 0, 5}]
23-
= {1, -1 / 2, 1 / 6, 0, -1 / 30, 0}
30+
= ...
31+
32+
## This must be (according to WMA)
33+
## = {1, -1 / 2, 1 / 6, 0, -1 / 30, 0}
34+
## but for some reason, in the CI the previous test produces
35+
## the output:
36+
## {1, 1 / 2, 1 / 6, 0, -1 / 30, 0}
2437
2538
First five Bernoulli polynomials:
2639

0 commit comments

Comments
 (0)