Address comments

Author: minggangw

lib/node.js

@@ -1080,18 +1080,19 @@ class Node extends rclnodejs.ShadowNode {
    *
    * When the `no_mangle` parameter is `true`, the provided `topic` should be a valid
    * topic name for the middleware (useful when combining ROS with native middleware (e.g. DDS)
-   * apps).  When the `no_mangle` parameter is `False`, the provided `topic` should
+   * apps).  When the `no_mangle` parameter is `false`, the provided `topic` should
    * follow ROS topic name conventions.
    *
    * `topic` may be a relative, private, or fully qualified topic name.
    *  A relative or private topic will be expanded using this node's namespace and name.
    *  The queried `topic` is not remapped.
+   *
    * @param {string} topic - The topic on which to find the publishers.
-   * @param {boolean} noDemangle - If `true`, `topic` needs to be a valid middleware topic
+   * @param {boolean} [noDemangle=false] - If `true`, `topic` needs to be a valid middleware topic
    *                               name, otherwise it should be a valid ROS topic name. Defaults to `false`.
    * @returns {Array} - list of publishers
    */
-  getPublishersInfoByTopic(topic, noDemangle) {
+  getPublishersInfoByTopic(topic, noDemangle = false) {
     return rclnodejs.getPublishersInfoByTopic(
       this.handle,
       this._getValidatedTopic(topic, noDemangle),
@@ -1107,18 +1108,19 @@ class Node extends rclnodejs.ShadowNode {
    *
    * When the `no_mangle` parameter is `true`, the provided `topic` should be a valid
    * topic name for the middleware (useful when combining ROS with native middleware (e.g. DDS)
-   * apps).  When the `no_mangle` parameter is `False`, the provided `topic` should
+   * apps).  When the `no_mangle` parameter is `false`, the provided `topic` should
    * follow ROS topic name conventions.
    *
    * `topic` may be a relative, private, or fully qualified topic name.
    *  A relative or private topic will be expanded using this node's namespace and name.
    *  The queried `topic` is not remapped.
+   *
    * @param {string} topic - The topic on which to find the subscriptions.
-   * @param {boolean} noDemangle -  If `True`, `topic` needs to be a valid middleware topic
-                                    name, otherwise it should be a valid ROS topic name. Defaults to `False`.
+   * @param {boolean} [noDemangle=false] -  If `true`, `topic` needs to be a valid middleware topic
+                                    name, otherwise it should be a valid ROS topic name. Defaults to `false`.
    * @returns {Array} - list of subscriptions
    */
-  getSubscriptionsInfoByTopic(topic, noDemangle) {
+  getSubscriptionsInfoByTopic(topic, noDemangle = false) {
     return rclnodejs.getSubscriptionsInfoByTopic(
       this.handle,
       this._getValidatedTopic(topic, noDemangle),
@@ -1457,7 +1459,7 @@ class Node extends rclnodejs.ShadowNode {
    * Determine if a parameter descriptor exists.
    *
    * @param {string} name - The name of a descriptor to for.
-   * @return {boolean} - True if a descriptor has been declared; otherwise false.
+   * @return {boolean} - true if a descriptor has been declared; otherwise false.
    */
   hasParameterDescriptor(name) {
     return !!this.getParameterDescriptor(name);

types/node.d.ts

@@ -750,21 +750,45 @@ declare module 'rclnodejs' {
     getServiceNamesAndTypes(): Array<NamesAndTypesQueryResult>;
 
     /**
-     * Get an array of publishers on a given topic.
+     * Return a list of publishers on a given topic.
      *
-     * @param topic - The name of the topic.
-     * @param noDemangle - if `true`, `topic_name` needs to be a valid middleware topic name,
-     *       otherwise it should be a valid ROS topic name.
+     * The returned parameter is a list of TopicEndpointInfo objects, where each will contain
+     * the node name, node namespace, topic type, topic endpoint's GID, and its QoS profile.
+     *
+     * When the `no_mangle` parameter is `true`, the provided `topic` should be a valid
+     * topic name for the middleware (useful when combining ROS with native middleware (e.g. DDS)
+     * apps).  When the `no_mangle` parameter is `false`, the provided `topic` should
+     * follow ROS topic name conventions.
+     *
+     * `topic` may be a relative, private, or fully qualified topic name.
+     *  A relative or private topic will be expanded using this node's namespace and name.
+     *  The queried `topic` is not remapped.
+     *
+     * @param topic - The topic on which to find the publishers.
+     * @param [noDemangle=false] - If `true`, `topic` needs to be a valid middleware topic
+     *                       name, otherwise it should be a valid ROS topic name. Defaults to `false`.
      * @returns An array of publishers.
      */
     getPublishersInfoByTopic(topic: string, noDemangle: boolean): Array<object>;
 
     /**
-     * Get an array of subscriptions on a given topic.
+     * Return a list of subscriptions on a given topic.
      *
-     * @param topic - The name of the topic.
-     * @param noDemangle - if `true`, `topic_name` needs to be a valid middleware topic name,
-     *     otherwise it should be a valid ROS topic name.
+     * The returned parameter is a list of TopicEndpointInfo objects, where each will contain
+     * the node name, node namespace, topic type, topic endpoint's GID, and its QoS profile.
+     *
+     * When the `no_mangle` parameter is `true`, the provided `topic` should be a valid
+     * topic name for the middleware (useful when combining ROS with native middleware (e.g. DDS)
+     * apps).  When the `no_mangle` parameter is `false`, the provided `topic` should
+     * follow ROS topic name conventions.
+     *
+     * `topic` may be a relative, private, or fully qualified topic name.
+     *  A relative or private topic will be expanded using this node's namespace and name.
+     *  The queried `topic` is not remapped.
+     *
+     * @param topic - The topic on which to find the subscriptions..
+     * @param [noDemangle=false] - If `true`, `topic` needs to be a valid middleware topic
+                           name, otherwise it should be a valid ROS topic name. Defaults to `false`.
      * @returns An array of subscriptions.
      */
     getSubscriptionsInfoByTopic(