Standardize and improve docstring #562
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Fix typos - For method JSDoc starting with a verb, standardize the verbs to be without the `-s` suffix - Add proper capitalization to JSDoc - Rephrase some JSDoc to make it clearer - Add parameter and return types to JSDoc - Add proper indication of optional parameters to JSDoc
Rayman
suggested changes
Aug 29, 2022
|
@jamestiotio Thanks for your efforts. Like @Rayman said the changes in the documentation is very welcome. I think any breaking change is not accepted. As I don't plan any major version bump any time soon (and not so soon as well). |
Understood. In that case, I have reverted the breaking changes. Essentially, I have aligned the docstrings to simply follow the implementation as the source of truth. To avoid confusion, I used the |
|
Please cherry-pick 605ef08 in your branch. Than we are good to go. Thanks for your efforts. |
|
@MatthijsBurgh Commit has been cherry-picked. |
MatthijsBurgh
approved these changes
Aug 31, 2022
MatthijsBurgh
requested changes
Aug 31, 2022
Co-authored-by: Matthijs van der Burgh <matthijs.vander.burgh@live.nl>
MatthijsBurgh
approved these changes
Aug 31, 2022
k-aguete
pushed a commit
to k-aguete/roslibjs
that referenced
this pull request
Oct 21, 2022
…#562) Bumps [@rollup/plugin-node-resolve](https://github.com/rollup/plugins/tree/HEAD/packages/node-resolve) from 13.3.0 to 14.1.0. - [Release notes](https://github.com/rollup/plugins/releases) - [Changelog](https://github.com/rollup/plugins/blob/master/packages/node-resolve/CHANGELOG.md) - [Commits](https://github.com/rollup/plugins/commits/node-resolve-v14.1.0/packages/node-resolve) --- updated-dependencies: - dependency-name: "@rollup/plugin-node-resolve" dependency-type: direct:development update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Merged
8 tasks
MatthijsBurgh
added a commit
that referenced
this pull request
Dec 4, 2023
* Standardize JSDoc format and add proper types to JSDoc - Fix typos - For method JSDoc starting with a verb, standardize the verbs to be without the `-s` suffix - Add proper capitalization to JSDoc - Rephrase some JSDoc to make it clearer - Add parameter and return types to JSDoc - Add proper indication of optional parameters to JSDoc * Remove dead code in ActionListener * Lint whitespace and align ActionServer param name with JSDoc * Refactor Ros.js to align callback parameters with JSDoc * Update check-topics tests * Fix check-topics example test * Revert breaking changes and align docstring to impl as source of truth * Remove 'An object with the following keys' * Specify default param values explicitly in docstring Co-authored-by: Matthijs van der Burgh <matthijs.vander.burgh@live.nl> * Fix typos * Specify more default param values Co-authored-by: Matthijs van der Burgh <MatthijsBurgh@outlook.com> Co-authored-by: Matthijs van der Burgh <matthijs.vander.burgh@live.nl>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Public API Changes
The refactoring to
core/Ros.jsmight break some applications. However, the proposed changes would make the public API more straightforward in two ways:getNodeDetailsmethod, the callback function signature now remains the same, whether there is afailedCallbackfunction defined or not. Previously, the function signature differs between the two, which might lead to further confusion.Description
This PR standardizes and improves the docstring, along with a few other small things.
More specifically, this PR does the following (in rough order of significance):
-ssuffix.Additionally, there are some non-docstring changes (again, in rough order of significance):
core/Ros.jsto align the callback parameters with the ones specified in the corresponding docstrings. Tests are also updated to follow the new callback function signatures.setSucceeded,setAborted, andsendFeedbackinactionlib/SimpleActionServer.jswith the respective docstrings.actionlib/ActionListener.js(the optionstimeout,omitFeedback,omitStatus, andomitResultare not used there).actionlib/SimpleActionServer.jsandcore/SocketAdapter.js.Relevant GitHub issues:
This PR closes #542.