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 documentation #48
Comments
Thanks for opening this issue. 👍 |
Hi @bryansum, I know this isn't quite what you were looking for, but there's an article by @arigrant in issue 19 of objc.io that covers LLDB and Chisel. http://www.objc.io/issue-19/lldb-debugging.html |
@bryansum I copy and pasted from help like you suggested. Nothing special but it's now up for improvement - https://github.com/facebook/chisel/wiki |
Thank you for reporting this issue and appreciate your patience. We've notified the core team for an update on this issue. We're looking for a response within the next 30 days or the issue may be closed. |
Seems to me the best way to do this is to use something like Sphinx to autogenerate documentation from the code and then require all functions have sufficient documentation within the code. Ideas / comments? |
It would be nice to have a more comprehensive set of docs in the GitHub wiki (perhaps even just copy/pasted from help , initially). It's not clear from the README what all of these awesome commands can do!
The text was updated successfully, but these errors were encountered: