Coder Social home page Coder Social logo

Documentation? about middleclass HOT 1 CLOSED

kikito avatar kikito commented on August 22, 2024
Documentation?

from middleclass.

Comments (1)

kikito avatar kikito commented on August 22, 2024

Am I missing something?

You might have missed that that particular wiki page was written in 2010.

Things have changed a bit since then. I now believe that code should be written in a way that is self-explanatory, without relying on comments for clarity.

Please consider the Readme and the Wiki as the main documentation now. Even if I think the code is readable, I do understand that some people need to have something in natural language in order to get familiar with a system.

One of the reasons why I prefer reading code to documentation is that the latter tends to get "out of sync with reality". This very issue is an example of that problem, in fact. I have resynched the wiki with reality.

Thanks for helping me fix the problem, and have a good day!

from middleclass.

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.