-
Notifications
You must be signed in to change notification settings - Fork 2
/
notes.txt
25 lines (12 loc) · 934 Bytes
/
notes.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
improvements for code:
1. fix discrepancies between modules (startDate/endDate vs first/last, dataVals vs datavals)
code seems to work anyway but this is very confusing in the documentation (unless this was intentional for some reason?)
2. hide methods/functions not intended for the user in Databank.py so that help(databank) isn't so verbose
3. consider impact of Dos vs Unix carriage returns in data file for databank_io.py
4. consider organization for package LICENSE.txt, README.txt, etc.
good info here: http://the-hitchhikers-guide-to-packaging.readthedocs.io/en/latest/quickstart.html
improvements for documentation:
1. find a solution for what to call the "user/model" (the thing that will be calling databank) i tried to make a note of it in the foreward. maybe this is good enough.
2. more concise summary of databank in section 4
3. better formatting (LaTex)
4. stop using sooooo many parenthesese (James!)