Add channel omission flags to ActionClient's JSDoc param tag

RobotWebTools / roslibjs

The Standard ROS JavaScript Library

https://robotwebtools.github.io/roslibjs

Other

678 stars 378 forks source link

Add channel omission flags to ActionClient's JSDoc param tag #556

Closed jamestiotio closed 2 years ago

jamestiotio commented 2 years ago

Public API Changes This PR makes the following channel omission flags for ActionClient explicitly visible to the user via JSDoc's @param tag:

omitFeedback
omitStatus
omitResult

Description This change is in line with PR #202. This PR explicitly allows the aforementioned channel omission flags to be passed in as part of the options parameter of the constructor function of ActionClient.

MatthijsBurgh commented 2 years ago

Thanks.

I think the GitHub hosted docs will only be updated on a new release. So you will have to wait for it to be available online. But you can generate the docs yourself.

jamestiotio commented 2 years ago

I think the GitHub hosted docs will only be updated on a new release. So you will have to wait for it to be available online. But you can generate the docs yourself.

No problem, thanks!