Adminsitriva

Add doctest testing to "make check"
Go over and update precommit hooks
Go over doc examples.

Author: rocky

.gitignore

@@ -4,6 +4,7 @@
 /ChangeLog-spell-corrected
 /ChangeLog.orig
 /Mathics3_Module_hello.egg-info
+/Mathics3_hello.egg-info
 /build
 /dist
 /tmp

.pre-commit-config.yaml

@@ -2,27 +2,24 @@ default_language_version:
   python: python
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.0.1
+    rev: v4.5.0
     hooks:
     - id: check-merge-conflict
     - id: debug-statements
       stages: [pre-commit]
+      exclude: ChangeLog-spell-corrected.diff
     - id: end-of-file-fixer
       stages: [pre-commit]
-# -   repo: https://github.com/pycqa/isort
-#     rev: 5.10.1
-#     hooks:
-#       - id: isort
-#         stages: [commit]
+      exclude: ChangeLog-spell-corrected.diff
+-   repo: https://github.com/pycqa/isort
+    rev: 5.13.2
+    hooks:
+      - id: isort
+        stages: [pre-commit]
 -   repo: https://github.com/psf/black
-    rev: 22.3.0
+    rev: 23.12.1
     hooks:
     - id: black
       language_version: python3
       exclude: 'pymathics/hello/version.py'
       stages: [pre-commit]
--   repo: https://github.com/pycqa/flake8
-    rev: 3.9.2
-    hooks:
-      - id: flake8
-        stages: [pre-commit]

Makefile

@@ -16,7 +16,7 @@ LANG = en
    pypi-setup \
    pytest \
    rmChangeLog \
-   test
+   doctest pytest test
 
 #: Default target - same as "develop"
 all: develop
@@ -38,7 +38,7 @@ install:
 	$(PYTHON) setup.py install
 
 # Run tests
-check: pytest
+check: pytest doctest
 
 #: Remove derived files
 clean: clean-pyc
@@ -47,11 +47,15 @@ clean: clean-pyc
 clean-pyc:
 	@find . -name "*.pyc" -type f -delete
 
+#:
+doctest:
+	MATHICS_CHARACTER_ENCODING="ASCII" $(PYTHON) -m mathics.docpipeline -l pymathics.hello -c 'Example Mathics3 Module' $o
 #: Run py.test tests. Use environment variable "o" for pytest options
 pytest:
 	py.test test $o
 
 
+
 # #: Make Mathics PDF manual
 # doc mathics.pdf: mathics/doc/tex/data
 # 	(cd mathics/doc/tex && $(MAKE) mathics.pdf)

pymathics/hello/__init__.py

@@ -1,10 +1,10 @@
 # -*- coding: utf-8 -*-
 """
-PyMathics Hello test module.
+Example Mathics3 Module
 
-This is an example of an external PyMathics module.
+This is an example of an external Mathics3 Module.
 
-A PyMathics module is a Python module which can be loaded into Mathics using the
+A Mathics3 Module is a Python module which can be loaded into Mathics using the
 ``LoadModule[]`` method.
 
 In particular, to load this after installing this module as a Python module run inside
@@ -27,8 +27,8 @@
 
 """
 
-from pymathics.hello.version import __version__
 from pymathics.hello.__main__ import Hello
+from pymathics.hello.version import __version__
 
 __all__ = ("__version__", "Hello", "pymathics_version_data")
 

pymathics/hello/__main__.py

@@ -12,18 +12,16 @@ class Hello(Builtin):
       <dd>An example function in a Python-importable Mathics3 module.
     </dl>
 
-    >> PyMathics`Hello["World"]
+    >> Hello[]
+     = "Hello, World!"
+
+    >> Hello["Everyone"]
+     = Hello, "Everyone!"
 
     See also the <url>
     :developer guide section:
     https://mathics-development-guide.readthedocs.io/en/latest/extending/developing-code/extending/tutorial/1-builtin.html</url> for an \
     explanation of everything.
-
-    >> Hello[]
-     = Hello, World!
-
-    >> Hello["rocky"]
-     = Hello, rocky!
     """
 
     summary_text = """classic "hello" demo"""