Added a to do list of things that should be done

This commit is contained in:
James P. Howard, II
2022-08-19 20:41:11 -04:00
parent 67cdf9bc29
commit 8613bc29b3
3 changed files with 28 additions and 1 deletions

View File

@@ -1,7 +1,9 @@
Changelog
=========
- :feature `0` Removed step()/run() from Model interface
- :feature:`0` Added a to do list to the documentation
- :feature:`0` Completed basic unit tests
- :feature:`0` Removed step()/run() from Model interface
- :feature:`0` Revised interfaces to the grids
- :feature:`0` Updated all support packages to most current versions

View File

@@ -62,4 +62,5 @@ model.
tutorial
api/library_root
changelog
todo
license

24
docs/todo.rst Normal file
View File

@@ -0,0 +1,24 @@
To Do List
==========
Must Dos
--------
The list below is a list of things considered necessary before
a 1.0 release. This list is *not* static.
- Network domain
- Data collection process
- Demonstration of data collection process
- Tutorial write up
Wishlist
--------
The list below is a list of things considered nice to have at
any point.
- Revise unit tests to take advantage of fixtures
- Documentation with basic introduction to ABMs
- Network Boltzmann model example
- Additional examples as appropriate
.. toctree::