GithubHelp home page GithubHelp logo

Comments (4)

jspahrsummers avatar jspahrsummers commented on April 19, 2024

If an edge case isn't documented, it's probably not intended behavior; for example, #136 and #138 are both critical bugs that need to be fixed.

I agree that RAC could use some better documentation, but, unless we're talking about examples/tutorials, I'm not sure why it needs to be external to class and method documentation – maybe with the one exception of memory management (since it's sort of a global philosophy).

from reactivecocoa.

dannygreg avatar dannygreg commented on April 19, 2024

"Edge cases" aside, I definitely think RAC is in need of a nice overview document. A place to explain overarching concepts of the framework and where the various classes fit in. A primer before diving into the class-based documentation.

Only having class-level documentation can be fairly disorientating when discovering a new framework.

from reactivecocoa.

joshaber avatar joshaber commented on April 19, 2024

Yep, I agree an overview doc would be good. Some things don't fit naturally as documentation on one class.

from reactivecocoa.

jspahrsummers avatar jspahrsummers commented on April 19, 2024

(Edited issue title to match the discussion.)

from reactivecocoa.

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.