diff --git a/README.md b/README.md index 2304c6de..f72e46fb 100644 --- a/README.md +++ b/README.md @@ -67,7 +67,7 @@ To install a specific version of rclnodejs use: npm i rclnodejs@x.y.z ``` -- **Note:** to install rclnodejs from GitHub: add `"rclnodejs":"RobotWebTools/rclnodejs#"` to your `package.json` depdendency section. +- **Note:** to install rclnodejs from GitHub: add `"rclnodejs":"RobotWebTools/rclnodejs#"` to your `package.json` dependency section. ## rclnodejs-cli diff --git a/benchmark/README.md b/benchmark/README.md index ca3802a8..388bbdd5 100644 --- a/benchmark/README.md +++ b/benchmark/README.md @@ -26,7 +26,7 @@ The table lists the directories for each kind of the ROS 2.0 clients. | :-------: | ------------------------------------------------------ | | topic | Benchmarks for `publisher` and `subscription` features | | service | Benchmarks for `client` and `service` features | -| startup | Benchamrks for measuring the startup time consumption | +| startup | Benchmarks for measuring the startup time consumption | ## Run tests @@ -34,14 +34,14 @@ The table lists the directories for each kind of the ROS 2.0 clients. - Compile the source files, `cd benchmark/rclcpp/` and run `colcon build` - The executable files locate at `build/rclcpp_benchmark/` -- `your_benchamrk -h` for help. +- `your_benchmark -h` for help. 2.Benchmark for [rclpy](https://github.com/ros2/rclpy) - Enter the Python scripts folder `benchmark/rclpy/` -- `python3 your_benchamrk -h` for help. +- `python3 your_benchmark -h` for help. 3.Benchmark for rclnodejs - Enter the Node.js scripts folder `benchmark/rclnodejs/` -- `node your_benchamrk -h` for help. +- `node your_benchmark -h` for help. diff --git a/docs/BUILDING.md b/docs/BUILDING.md index b176431d..52317e97 100644 --- a/docs/BUILDING.md +++ b/docs/BUILDING.md @@ -8,7 +8,7 @@ ROS 2 is a cross-platform system, which covers Linux, macOS and Windows, and the 2.Build ROS 2 from scratch. -Alternatively, you can build ROS 2 from scratch. Please select the platform you want to work on, then reference the instructions of [Linux](https://index.ros.org/doc/ros2/Installation/Linux-Development-Setup/)/[macOS](https://index.ros.org/doc/ros2/Installation/OSX-Development-Setup/)/[Windows](https://index.ros.org/doc/ros2/Installation/Windows-Development-Setup/) to build ROS 2 (please build wiht flag `--merge-install`). +Alternatively, you can build ROS 2 from scratch. Please select the platform you want to work on, then reference the instructions of [Linux](https://index.ros.org/doc/ros2/Installation/Linux-Development-Setup/)/[macOS](https://index.ros.org/doc/ros2/Installation/OSX-Development-Setup/)/[Windows](https://index.ros.org/doc/ros2/Installation/Windows-Development-Setup/) to build ROS 2 (please build with flag `--merge-install`). ### Install `Node.js` @@ -17,7 +17,7 @@ Alternatively, you can build ROS 2 from scratch. Please select the platform you I install Nodejs from either: -- Node.js offical [website](https://nodejs.org/en/) +- Node.js official [website](https://nodejs.org/en/) - Node Version Manager ([nvm](https://github.com/creationix/nvm)) ### Get Code diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 52cb95de..4db5e149 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -23,7 +23,7 @@ Here's the process to follow once a bug or feature request has been assigned to 4. Run the test suite and ensure all tests pass. 5. Commit your changes to your cloned repo. -#### Submiting your Code +#### Submitting your Code 1. Submit your changes for review by opening a Pull Request (PR) on the rclnodejs project. Fix any CI failures resulting from your code changes. 2. The PR will be reviewed by the project team members. Please keep the PR updated to reflect reviewer comments and requests. You may also be requested to rebase the PR and fix any conflicts. When the PR has gained "Looks Good To Me (LGTM)" status, the project maintainers will merge the PR. diff --git a/docs/EFFICIENCY.md b/docs/EFFICIENCY.md index 4c8095f1..6f909a19 100644 --- a/docs/EFFICIENCY.md +++ b/docs/EFFICIENCY.md @@ -1,6 +1,6 @@ # Tips for efficent use of rclnodejs -While our benchmarks place rclnodejs performance at or above that of [rclpy](https://github.com/ros2/rclpy) we recommend appyling efficient coding and configuration practices where applicable. +While our benchmarks place rclnodejs performance at or above that of [rclpy](https://github.com/ros2/rclpy) we recommend applying efficient coding and configuration practices where applicable. ## Tip-1: Disable Parameter Services diff --git a/docs/FAQ.md b/docs/FAQ.md index 17a58375..8f14a82a 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -9,7 +9,7 @@ The most common reasons for this error are: * The ROS package containing the target message was installed after the `rclnodejs` package was installed in your ROS2-nodejs environment. #### Verify the ROS package is installed -The first step is to verify that your ROS environment includes the package containing the target message. Using the `ros2` cli list all of the packages in your ROS envionrment and inspect the output for the package. +The first step is to verify that your ROS environment includes the package containing the target message. Using the `ros2` cli list all of the packages in your ROS environment and inspect the output for the package. ``` ros2 pkg list ``` diff --git a/rostsd_gen/readme.md b/rostsd_gen/readme.md index c6f6e5c0..11e24c1d 100644 --- a/rostsd_gen/readme.md +++ b/rostsd_gen/readme.md @@ -2,7 +2,7 @@ A node.js script that creates and updates the TypeScript interfaces.d.ts declaration file with type declarations for the generated interfaces (messages and services). -Run this script everytime new interfaces are generated, see script/generate_messages.js +Run this script every time new interfaces are generated, see script/generate_messages.js # run diff --git a/tutorials/actionlib.md b/tutorials/actionlib.md index bb2982a6..88ec9019 100644 --- a/tutorials/actionlib.md +++ b/tutorials/actionlib.md @@ -4,7 +4,7 @@ Actionlib tutorial based on `rclnodejs`. ## Actionlib background -To continue the tutorial, you should have some basic understanding of the `action` term in ROS. If you're not familar with it, please refer to the [description](http://wiki.ros.org/actionlib/DetailedDescription). +To continue the tutorial, you should have some basic understanding of the `action` term in ROS. If you're not familiar with it, please refer to the [description](http://wiki.ros.org/actionlib/DetailedDescription). ## Precondition @@ -84,7 +84,7 @@ And here is the action server output: A goal, whose id is 7c28f24a-5ce8-4b13-a2aa-7aa62128fd03, was received. ``` -## Explaination of the action example: +## Explanation of the action example: 1. Action server For the action server, the skeleton code is like this: @@ -162,8 +162,8 @@ rclnodejs.init().then(() => { To construct an action client, use `new rclnodejs.ActionClientInterface()`. The action client can emit 3 type events: -- `status` event: tirggered when the action server sends messages to the action client during the goal is executing. +- `status` event: triggered when the action server sends messages to the action client during the goal is executing. - `feedback` event: triggered after the action server called `publishFeedback`. - `result` event: triggered after the action server called `setSucceeded`. -**Notice**, the action state transitions must obey some specific order, for more details please refer to [this articile](http://wiki.ros.org/actionlib/DetailedDescription) +**Notice**, the action state transitions must obey some specific order, for more details please refer to [this article](http://wiki.ros.org/actionlib/DetailedDescription)