Giter Site home page Giter Site logo

Improve documentation about chisel HOT 5 OPEN

facebook avatar facebook commented on April 20, 2024
Improve documentation

from chisel.

Comments (5)

kastiglione avatar kastiglione commented on April 20, 2024

Thanks for opening this issue. 👍

from chisel.

kastiglione avatar kastiglione commented on April 20, 2024

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

from chisel.

suite22 avatar suite22 commented on April 20, 2024

@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

from chisel.

 avatar commented on April 20, 2024

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.

from chisel.

idrisr avatar idrisr commented on April 20, 2024

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?

from chisel.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.