871 clarify channels behaviour and fix a markdown issue in API spec #971
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
kriswest
added
bug
✅ Deploy Preview for fdc3 canceled.
|
|
Actually, this PR doesn't include changes to the 1.2 docs, which is mentioned in the issue and I know we had discussed. Do we still want to include those updates? I'm happy to make those changes and update this branch. |
|
@greyseer256 If you're up for making the 1.2 changes, please go for it. No need to touch the /src/api/* file comments however, unless we want to release an npm module version with updated comments and a 1.2.x version number. The website's documentation is more accessible however. |
Co-authored-by: Hugh Troeger <htroeger@factset.com>
|
@greyseer256 on reflection, I'm not that worried about 1.2 docs. Still happy for the addition to go there too, but I think people will mostly read the current version of the documentation (and NPM module with comments). |
docs(1.2): clarify language about channel joining behavior
kriswest
commented
May 23, 2023
kriswest
commented
May 23, 2023
27 tasks
18 tasks
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.
resolves #871
Adds an additional clarifying note on user/app channel behaviour differences.
Corrects a few spelling errors in API spec and Americanizes some spellings 🤢
Fixes a markdown rendering issue in the Desktop Agent specification I encountered while editing: