README: Expand the Scribble milestone to types and include more details.

This commit is contained in:
Sergiu Ivanov 2020-11-12 17:08:00 +01:00
parent 7de4c5ef71
commit 99c74ba659

View file

@ -38,8 +38,44 @@ interaction with Org-mode.
Check that the definition of this function really follows the Check that the definition of this function really follows the
definition of the interaction graph. Pay attention to the definition of the interaction graph. Pay attention to the
existential vs. universal quantifiers. existential vs. universal quantifiers.
*** TODO Write the docs properly with Scribble *** TODO Start writing the docs properly with Scribble
https://docs.racket-lang.org/scribble/srcdoc.html Convert some of the comments to Scribble, in particular
module-level comments introducing the modules and each of
the sections.
Set up the infrastructure for extracting the in-source comments
using [[https://docs.racket-lang.org/scribble/srcdoc.html][this]].
*** TODO Think about /not/ using generics for the dynamics
Typed Racket can now type classes, and I can implement the idea
from the module =generics= as a class. However, I got this advice
on Racket Users group:
#+BEGIN_QUOTE
If you don't need to support arbitrary user implementations, you
can avoid generics and classes altogether and use structs whose
fields contain functions.
#+END_QUOTE
I will need to think about simpler implementations of the
interface to dynamics, which should also be simpler to type.
*** TODO Convert =dds= to Typed Racket
This will necessarily lead to updates in the comments, which
should be rewritten with Scribble.
I will do the conversion in the directory =typed/=, by
incrementally translating existing modules, definition
by definition.
The order I will convert the modules:
1. =utils=
2. =functions=
3. the module defining the interface to dynamics (currently =generics=)
4. =networks=
5. =rs=
*** TODO Submit =update-graph= to =stchang= *** TODO Submit =update-graph= to =stchang=
*** TODO Implement the BN \to RS conversion *** TODO Implement the BN \to RS conversion
*** TODO Implement the minimisation of TBF/SBF *** TODO Implement the minimisation of TBF/SBF