GithubHelp home page GithubHelp logo

Comments (7)

asaaki avatar asaaki commented on September 18, 2024 6

But wouldn't it be more beneficial to have speaking variable names instead?
Comments can be valuable, but should focus more on the Why instead of What, therefore the code itself should be better understandable in the what part.

Unless there was a need to win in a code golfing competition, there shouldn't be a need for single letter variables anyway.

from greenlet.

carstenhag avatar carstenhag commented on September 18, 2024 1

Someone already annotated it:

https://news.ycombinator.com/item?id=16258172
https://gist.github.com/zz85/25564f1910f1877c39c25ace5e5159bc

from greenlet.

zz85 avatar zz85 commented on September 18, 2024 1

@developit sure, go ahead with it!

the single letter variables look rather cryptic at first and could be better named, but it was also fun trying to understand what it was doing. knowing a little about promises, web workers and javascript helped too i guess :)

from greenlet.

developit avatar developit commented on September 18, 2024

I love the idea of comments annotating things!

from greenlet.

developit avatar developit commented on September 18, 2024

Yup!

from greenlet.

developit avatar developit commented on September 18, 2024

Hey @zz85 - mind if I add some of your annotations to the library itself?

from greenlet.

developit avatar developit commented on September 18, 2024

Should be much more readable now.

from greenlet.

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.