Documentation update to help new programmers #2599
Merged
+24
−20
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The documentation, inadvertently, causes confusion for newer programmers, hindering their learning curve and ability to learn `socket.io` faster. This proposed change aims at preventing this confusion to allow new programmers easier access to resources, especially when searching the web for more information. The name `socket` in the documentation refers to the API gateway, or abstraction layer, related to the `client` and other properties. However, in the rest of the programming world, `sockets` usually refer to Berklee sockets or the lower-level communication channel that is used to implement Protocols such as the Websocket Protocol and HTTP. New programmers often search for more informations using the `sockets` keyword when they are grappling with learning the `socket.io` API. A good example is the stack overflow site, where newer programmers incorrectly tag their questions `sockets` and in turn don't get a fast response to their questions. By simply changing the name of the variable used to describe socket.io's "Socket" class instances from `socket` to `client`, this mixup should be mitigated considerably.
|
I only updated the README, the failing build is not my fault... |
boazsegev
changed the title
|
Hi, thanks a lot for your contribution! |
Closed
dzad
pushed a commit
to dzad/socket.io
that referenced
this pull request
May 29, 2023
Documentation update to help new programmers
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The documentation, inadvertently, causes confusion for newer programmers, hindering their learning curve and ability to learn
socket.iofaster.This proposed change aims at preventing this confusion in order to allow new programmers easier access to resources, especially when searching the web for more information.
The name
socketin the documentation refers to the API gateway, or the abstraction layer, related to theclientand other properties. However, in the rest of the programming world,socketsusually refer to Berklee sockets or the lower-level communication channel that is used to implement Protocols such as the Websocket Protocol and HTTP.New programmers often search for more informations using the
socketskeyword when they are grappling with learning thesocket.ioAPI. These searches are ineffective, and hinder new programmers from accessing the information they need and advancing as fast as they could have been advancing.A good example is the stack overflow site, where newer programmers incorrectly tag their questions
socketsand in turn their questions don't reach the right community and don't get a (prompt) response.By simply changing the name of the variable used to describe socket.io's "Socket" class instances from
sockettoclient, this mixup should be mitigated considerably.