Skip to content

Loading…

Code Documentation sucks #46

Closed
maxfierke opened this Issue · 0 comments

1 participant

@maxfierke
OfficeStack member

Due to the speed at which I work on OpenSkedge, the lack of other contributors, and the fact that I generally know my code like the back of my hand, I have failed to provide adequate commenting of my code. This makes the barrier to entry into OpenSkedge rather high as it takes fair amount of analysis of my code before what is being done is as clear as it is to me.

I will make an effort to add more documentation to the code from here on out. This issue will stay open until I have added function, parameter, and return value comments to all methods and go through some of the more difficult logic in some classes and thoroughly document what's going on.

@maxfierke maxfierke was assigned
@maxfierke maxfierke removed this from the 1.0 Beta and branch onto beta milestone
@maxfierke maxfierke added this to the 2.0.0 Roadmap milestone
@maxfierke maxfierke closed this
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.