Current TODO List

The following is an automatically generated list of TODO items from the source code.

Anyone wishing to get involved with the project could well start on implementing a new feature, or address one of these existing TODO items.

The convention to mark a TODO item in the code is the # TODO: prefix, followed by HIGH, MED, LOW which is a very simple indicator of urgency.

  • HIGH are items that should be addressed by the next round of edits / release

  • MED are items that might require some form of re-design to be applied and require more long-term thinking.

  • LOW are items that would be good to have at some point in the future but are not immediately required to deliver a specific piece of functionality.

The following list has been produced with the doc/get_todos.sh script and is formatted in the standard egrep -Hn output format.

Specific Items

TODO List as of Tue 10 Nov 20:18:25 GMT 2020
../dgtools/assembler.py:34 TODO: LOW, Rename uchar, as it is not a uchar anymore. This is a remnant.
../dgtools/callbacks.py:136 TODO: LOW, Rename DigiruleCallbackComOutStdout to a more generic name because it is more generally applicable.
../dgtools/dginspect.py:99 TODO: HIGH, Add a mode that only generates an update of the VM state when the state of one of the tracked symbols changes
../dgtools/dginspect.py:109 TODO: MID, Reduce code duplication by packaging this validation in a function
../dgtools/dginspect.py:156 TODO: HIGH, the following operations can be "absorbed" into the DGB_Archive with appropriate validations too
../dgtools/dgsust.py:90 TODO: HIGH, Needs to return proper message.
../dgtools/dgui.py:93 TODO: MED, It would be nice to have this working over any sort of path the input_file might be in.
../dgtools/dgui.py:109 TODO: LOW, It would be nice to have this work over any number of rules (needs a hint on the model)
../dgtools/dgui.py:227 TODO: MED, The production of the simple Makefile template will do for the moment but can do better 
../dgtools/digirule.py:24 TODO: MED, Need to add randa on the 2A 
../dgtools/digirule.py:29 TODO: MED, There might be constraints in the depth of this stack. Not yet implemented.
../dgtools/digirule.py:45 TODO: LOW, Make the speed setting functional
../dgtools/digirule.py:370 TODO: MED, In CBR and SBR, if the bit is zero, it should raise an error at compile time.
../dgtools/digirule.py:397 TODO: MED, If you get a RETLA without first having called CALL, it should raise an exception at compile time.
../dgtools/digirule.py:699 TODO: MED, This can raise a divide by zero warning / exception too
../dgtools/digirule.py:770 TODO: MED, Maybe this can be matched to a more realistic behaviour once comout, comin are connected to real files.
../dgtools/digirule.py:773 TODO: MID, Reduce code duplication in _comin, _comout
../dgtools/digirule.py:806 TODO: LOW, Improve the way the label is modified externally
../dgtools/makefile_rw.py:232 TODO: MID, Extended the pre_sim optional to the dgasm rule too
../dgtools/makefile_rw.py:259 TODO: MID, Make dependencies zero-to-many