Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Wiki and inline documentation needs to be caught up #117

Open
dgets opened this issue Apr 20, 2015 · 2 comments
Open

Wiki and inline documentation needs to be caught up #117

dgets opened this issue Apr 20, 2015 · 2 comments

Comments

@dgets
Copy link
Owner

dgets commented Apr 20, 2015

It's been left behind again in the flurry to get new features working properly. The wiki documentation is probably mostly up-to-date at this point, though a few areas in dperroom.js and dmail.js are non-existent and/or modified. The inline code needs to be seriously revised in at least these two areas, definitely some spots in ddoc2.js, and quite possibly other locations as well. Have fun.

@dgets
Copy link
Owner Author

dgets commented May 30, 2015

I'm going to start on this today in dmbase.js. Having appropriate documentation available to refer back to since the myriad of changes that has gone through will very much help when I start hitting issues like #140 and #141.

@dgets
Copy link
Owner Author

dgets commented May 31, 2015

As mentioned in the merge request above (#158), all of the inline documentation has been brought up to date, and some notes added. The wiki text has not yet been updated, so closing out this issue should pretty much consist just of going through the code for each of the applicable pages and making whatever necessary changes. Some of the more involved sub-objects and methods should probably have a little bit more on the internals documented, as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant