Git Product home page Git Product logo

Comments (9)

jinzhu avatar jinzhu commented on May 18, 2024

Hi @rogpeppe

We understand that, but the API is not freeze at that time (scheduled for September 2015), so we will do that before the finally launch.

from qor.

rogpeppe avatar rogpeppe commented on May 18, 2024

The API should be documented long, long before it's frozen.
Without documentation, I'm sorry to say it's essentially unusable.

from qor.

bodhi avatar bodhi commented on May 18, 2024

Without documentation, I'm sorry to say it's essentially unusable.

Please don't be hyperbolic, it's not constructive.

We agree that the documentation is important, but we haven't been able to make time to look at it yet. As @jinzhu said, it's still very early stages for QOR.

from qor.

jinzhu avatar jinzhu commented on May 18, 2024

@rogpeppe Thanks for your input… we will prioritize this higher and get these in soon

from qor.

mastrolinux avatar mastrolinux commented on May 18, 2024

I suggest to use golint that will help you filling proper comments for godoc.

from qor.

stuartweir avatar stuartweir commented on May 18, 2024

Is there anything I would be able to do to help in the documentation of QOR? Any specific areas?

from qor.

jinzhu avatar jinzhu commented on May 18, 2024

@stuartweir Thank you for that. If possible, it would be good to start from a new application, and document things that confuse you. (Sure, we are here to provide any help that you want)

from qor.

stuartweir avatar stuartweir commented on May 18, 2024

No problem! Alright! I'll do that 👍

from qor.

jinzhu avatar jinzhu commented on May 18, 2024

We have added lots of documents, please review each component's readme and godoc

from qor.

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.