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

Reformat code & documentation #52

Closed
neocotic opened this issue Dec 2, 2011 · 3 comments
Closed

Reformat code & documentation #52

neocotic opened this issue Dec 2, 2011 · 3 comments
Assignees
Milestone

Comments

@neocotic
Copy link
Member

@neocotic neocotic commented Dec 2, 2011

Reformat JavaScript code to follow more modern coding standards. Also, documentation to be updated to use docco. High risk job but I feel it should be done for the full release.

Build process will need updated to reflect these changes to documentation generation, which will probably be maintained in the repository from now on.

@ghost ghost assigned neocotic Dec 2, 2011
@neocotic
Copy link
Member Author

@neocotic neocotic commented Jan 9, 2012

Like iOrder, this will now also include conversion to CoffeeScript.

@neocotic
Copy link
Member Author

@neocotic neocotic commented Jan 16, 2012

Build process has been updated, the JavaScript code has been converted to CoffeeScript and there appears to be no errors and basic functionality is working, documentation has been changed to be compatible with docco and initial generated docs have been added to version control.

All that is left is more intense testing to ensure the conversion worked in all areas. This might possibly involve comparing the compiled JavaScript with the most recent version of the old handwritten JavaScript files. Also, final draft of docs will need to be generated just before 1.0.0 is released.

@neocotic
Copy link
Member Author

@neocotic neocotic commented Jan 20, 2012

Code/logic looks good after a quick comparison and I'm happy with the results. There may be bugs introduced but hopefully the testing of #49 will help uncover these.

Thankfully, no errors are being thrown up during common usage and nothing appears to be acting incorrectly.

@neocotic neocotic closed this Jan 20, 2012
neocotic added a commit that referenced this issue Jan 24, 2012
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
1 participant
You can’t perform that action at this time.