CNMAT / CNMAT-odot

Multi-paradigm Dynamic Programming

Other

115 stars 11 forks source link

dev folder: documentation and visibility #383

Closed ramagottfried closed 4 years ago

ramagottfried commented 5 years ago

I think we need some clearer documentation about the dev folder, since it's easy to forget it's there. How do users know to add the dev folder if they want to use those objects? At the moment I don't think there are any mentions of it.

related to issues:

274

and #329 and #149

equilet commented 5 years ago

My plan is to include language about this in the PM when the time comes. We spoke of that at the retreat this Monday.

ramagottfried commented 5 years ago

sounds good, maybe it should be in the overview -- and also maybe in the git readme, or anywhere where people are reading about how what the package contains

equilet commented 5 years ago

Surely it can stay in those places too.

maccallum commented 4 years ago

i updated the text in the subpatch in o.overview for the dev folder to explain what it represents.

i also added a subpatch for the deprecated folder with a similar note about why those objects are there, how to install them, etc.

i also put a readme file in both of those folders that contains the same information that's in those subpatches.

i'm satisfied with the state of this now, but feel free to reopen if there are other things to do / consider.