fix(calling-docs): calling sdk api doc update #3106
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
Kesari3008
changed the title
mkesavan13
requested changes
Sep 26, 2023
There was a problem hiding this comment.
Minor comments but a lot in number. To summarize,
- Bring all param names and descriptions back. That is still required.
- If the document is entirely new and does not have param descriptions, please add them
- For some APIs, if we are ignoring them in exposing on API reference, why the APIs are actually public?
| * | ||
| * Example - ContactGroup - https://github.com/webex/webex-js-sdk/wiki/Calling-Contacts#contactgroup | ||
| */ | ||
| createContactGroup( |
There was a problem hiding this comment.
Can mention param and descriptions.
There was a problem hiding this comment.
In class definitions we have it for the APIs, I feel in the interface we can avoid adding it
|
Also the PR title need not have the spark ticket ID since that is what is going to be shown in the commit history and would be public. The title shall look something like,
|
Kesari3008
changed the title
sreenara
requested changes
Sep 29, 2023
mkesavan13
requested changes
Oct 3, 2023
mkesavan13
reviewed
Oct 3, 2023
Kesari3008
added a commit
to Kesari3008/webex-js-sdk
that referenced
this pull request
Oct 3, 2023
Co-authored-by: Priya Kesari <pkesari@cisco.com>
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.
COMPLETES #https://jira-eng-gpk2.cisco.com/jira/browse/SPARK-428325
This pull request addresses
Calling SDK API doc changes
by making the following changes
Moved docs generation path from packages/calling/docs to docs/calling
Deleted docs folder from inside calling folder.
Updated the docs/index.html file to add the Calling API reference link which redirects to Calling SDK API docs.
Made changes in README.md file
Change in each class and interface files to have proper description of properties and methods.
Below modules have been changed in this PR:
CallHistory
CallSettings
Contacts
Change Type
The following scenarios where tested
< ENUMERATE TESTS PERFORMED, WHETHER MANUAL OR AUTOMATED >
I certified that
I have read and followed contributing guidelines
I discussed changes with code owners prior to submitting this pull request
I have not skipped any automated checks
All existing and new tests passed
I have updated the documentation accordingly
Make sure to have followed the contributing guidelines before submitting.