socket.io icon indicating copy to clipboard operation
socket.io copied to clipboard

chore(engine.io): fix comment formatting inconsistencies in socket.ts

Open vipin8797 opened this issue 2 weeks ago • 0 comments

The kind of change this PR does introduce

  • [x] a bug fix
  • [ ] a new feature
  • [ ] an update to the documentation
  • [ ] a code change that improves performance
  • [ ] other

Current behavior

The file packages/engine.io/lib/socket.ts currently contains several comment formatting inconsistencies, including:

  • Inconsistent capitalization (e.g., comments starting with lowercase)
  • Missing spaces after //
  • Missing periods at the end of full-sentence comments
  • TODO comment without colon and inconsistent indentation
  • Multi-line comments with uneven formatting

These issues reduce readability and make the file inconsistent with the rest of the codebase.

New behavior

This PR normalizes comment formatting across packages/engine.io/lib/socket.ts:

  • Capitalized all comment beginnings
  • Added missing periods for full-sentence comments
  • Normalized spacing after //
  • Improved the TODO comment format (TODO: with proper capitalization)
  • Cleaned up multi-line comment formatting for readability

No functional or behavioral code changes were introduced.

Other information (e.g. related issues)

This is a small internal cleanup PR intended to improve code readability and maintain consistency across the codebase.

No related issues.
よろしくお願いします!

vipin8797 avatar Nov 22 '25 09:11 vipin8797