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

Improve mach.json documentation & use the new markdown generator #17

Open
pineapplemachine opened this issue Mar 10, 2017 · 0 comments
Open

Comments

@pineapplemachine
Copy link
Owner

The mach.json package currently uses the old markdown documentation generator; the documentation should be moved out of mach/json/readme.md and into e.g. mach/json/json.d and mach/json/package.d and the package directory should be removed from the list in utils/makereadme.d and added to the list in utils/makereadme2.d.

The documentation is also generally lacking and could particularly use a greater number of example unit tests, most of which could be almost straight copy-pasted from the package's existing tests.

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