Skip to content
This repository has been archived by the owner on Jul 16, 2023. It is now read-only.

Commit

Permalink
add the beginning of troubleshooting docs
Browse files Browse the repository at this point in the history
  • Loading branch information
rjdbcm committed Nov 8, 2021
1 parent b985634 commit 8bfd419
Show file tree
Hide file tree
Showing 7 changed files with 26 additions and 1 deletion.
1 change: 1 addition & 0 deletions Aspidites/woma/fileutils.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# cython: language_level=3, annotation_typing=True, c_string_encoding=utf-8, boundscheck=False, wraparound=False, initializedcheck=False
# -*- coding: utf-8 -*-
"""Virtually every Python programmer has used Python for wrangling
disk contents, and ``fileutils`` collects solutions to some of the
Expand Down
1 change: 1 addition & 0 deletions Aspidites/woma/gcutils.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# cython: language_level=3, annotation_typing=True, c_string_encoding=utf-8, boundscheck=False, wraparound=False, initializedcheck=False
# -*- coding: utf-8 -*-
"""The Python Garbage Collector (`GC`_) doesn't usually get too much
attention, probably because:
Expand Down
1 change: 1 addition & 0 deletions Aspidites/woma/guiutils.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# cython: language_level=3, annotation_typing=True, c_string_encoding=utf-8, boundscheck=False, wraparound=False, initializedcheck=False
"""Disabled as of 2.1.6 but it does seem to work.Except with CD
"""
# TODO Fix dearpygui module not found
Expand Down
2 changes: 1 addition & 1 deletion Aspidites/woma/library.wom
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,5 @@
(mod(x = 0 -> number; y = 0 -> number)) number
<*> x % y

(mul(x = 0 -> number; y = 0 -> number)) number
(mul(x = 0 -> number; y = 0 -> number))
<*> x * y
1 change: 1 addition & 0 deletions Aspidites/woma/mathutils.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# cython: language_level=3, annotation_typing=True, c_string_encoding=utf-8, boundscheck=False, wraparound=False, initializedcheck=False
"""This module provides useful math functions on top of Python's
built-in :mod:`math` module.
"""
Expand Down
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@ Table of Contents
limits
indepth
builtins
troubleshooting
api
devinfo

20 changes: 20 additions & 0 deletions docs/troubleshooting.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Troubleshooting
###############

Expected end of text
--------------------

This is particularly common, unfortunately when you neglect certain parsable symbols you get this (rather unhelpful) error.
For these we have to look at the found context and look for whats missing.
In the following example we define a function but forgot to include a return annotation:

.. code-block:: woma
(mul(x = 0 -> number; y = 0 -> number))
<*> x * y
This is the error we get when we try to compile:

.. code-block::
Aspidites._vendor.pyparsing_extension.ParseException: Expected end of text, found in '(mul(x = 0 -> number'...

0 comments on commit 8bfd419

Please sign in to comment.