Skip to content

Conversation

@minggangw
Copy link
Member

@minggangw minggangw commented Mar 3, 2025

This patch removes obsolete comments and standardizes header and inline comment placements. The changes primarily involve reordering or removing ESLint disable comments, license header additions or removals, and the deletion of commented out legacy code.

Meanwhile, this patch re-enables test-raw-pub-sub.js on Linux platform.

Fix: #1052

@minggangw minggangw requested a review from Copilot March 3, 2025 06:43
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR Overview

This PR implements a code cleanup aimed at fixing issue #1052 by removing obsolete comments and standardizing header and inline comment placements. The changes primarily involve reordering or removing ESLint disable comments, license header additions or removals, and the deletion of commented out legacy code.

Reviewed Changes

File Description
rostsd_gen/index.js Moved ESLint disable comments to a new location following the license header.
rosidl_gen/filter.js Added a license header at the top of the file.
scripts/ros_distro.js Added a license header.
scripts/generate_messages.js Repositioned ESLint disable comment after the license header.
lib/rmw.js Added a license header to the file.
lib/parameter.js Moved ESLint disable comment to a location after the license header.
test/test-distro.js Added a license header and removed a commented out require statement.
lib/node.js Updated an inline comment’s capitalization for the ParameterEvent publication for consistency.
lib/parameter_service.js Updated the service comment block to include a new service type (GetParameterTypes).
test/test-extra-destroy-methods.js Removed commented out legacy code for clarity.
test/test-lifecycle-publisher.js Removed commented out code to improve readability.
scripts/run_test.js Removed the unused variable declaration.
test/test-compound-msg-type-check.js Removed an unnecessary commented require line.
rosidl_gen/message_translator.js Cleaned up unused debug logging and adjusted comment punctuation for consistency.
lib/rate.js Removed the license header, which should be verified for consistency with project guidelines.
test/array_generator.js Removed commented out code for generating arrays.

Copilot reviewed 31 out of 31 changed files in this pull request and generated no comments.

Comments suppressed due to low confidence (2)

lib/node.js:1499

  • [nitpick] The inline comment now uses a capitalized 'Publish' which deviates from the previous style; consider standardizing the comment style across the codebase.
    // Publish ParameterEvent.

lib/rate.js:1

  • The removal of the license header in this file may be unintentional or inconsistent with other files; please verify that this aligns with the project’s licensing guidelines.
// Licensed under the Apache License, Version 2.0 (the "License");

@minggangw minggangw merged commit c98ce74 into RobotWebTools:develop Mar 3, 2025
6 checks passed
minggangw added a commit that referenced this pull request Mar 6, 2025
This patch removes obsolete comments and standardizes header and inline comment placements. The changes primarily involve reordering or removing ESLint disable comments, license header additions or removals, and the deletion of commented out legacy code.

Meanwhile, this patch re-enables `test-raw-pub-sub.js` on Linux platform.

Fix: #1052
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Cleanup the code

1 participant