chisel icon indicating copy to clipboard operation
chisel copied to clipboard
verified publisher icon facebook

Improve documentation

Open bryansum opened this issue 11 years ago • 5 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!

bryansum avatar Sep 05 '14 21:09 bryansum

Thanks for opening this issue. :+1:

kastiglione avatar Sep 06 '14 04:09 kastiglione

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

kastiglione avatar Dec 11 '14 01:12 kastiglione

@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

suite22 avatar Jan 12 '15 20:01 suite22

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.

ghost avatar Aug 04 '15 18:08 ghost

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?

idrisr avatar Oct 12 '15 02:10 idrisr