GithubHelp home page GithubHelp logo

Comments (3)

mrleavitt avatar mrleavitt commented on June 23, 2024

Before I make any changes, could I query whether the parameter is better expressed as a logical or numeric expression? Whenever I see something that evaluates to either 0 or non-zero I think that maybe it's better thought of as a logical expression. If you agree, I'd add words something like this (yours, but with a few changes):


Socket.server.connect {< wait_lexp >}

The optional "wait" parameter determines if the command waits until a connection is made with a client. If the parameter is true (non-zero or missing), the command waits for the connection. If the parameter is false (0), the command completes immediately. Use socket.server.status to determine when the connection is made.

In general, it is better (safer, more robust) to set the parameter to false and explicitly monitor the connection's status, since it can avoid a problem if the program exits with no connection made.


Also, with regard to your last commend, I think I'd try to put the comment with the command (as above), as (it seems to me) that that's when someone is more likely to be thinking about it. If we put it in the introductory material, it might be forgotten by the time the coding starts.

What do you think?

from de-re-basic.

jMarcS avatar jMarcS commented on June 23, 2024

You're right, the parameter really is a logical expression. Somehow I missed that we're using lexp in descriptions of parameters. That's much better.

To me, "true (non-zero or missing)" implies "missing" means "true" for logical expressions in general. I think more often "missing" means "false", just not for this command. Can you live with, "If the parameter is absent or true (non-zero)", or something similar?

Putting the advice about using the parameter where you have it works well. With yesterday's code change, there's an even more compelling reason to connect without the wait.

from de-re-basic.

mrleavitt avatar mrleavitt commented on June 23, 2024

Done.

from de-re-basic.

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.