Update docs for added examples - execution data/streaming #105
Conversation
WalkthroughThe changes in this pull request involve updates to the README files for both Java and Kotlin examples. A new section titled "Get Execution Data" has been added to both README files, providing descriptions and links to code examples for retrieving execution data by block ID. Additionally, the Kotlin README includes a new section on "Streaming Events and Execution Data," which replaces outdated information regarding unsupported features. The overall structure of the documentation remains intact, with no deletions or modifications to existing content. Changes
Possibly related PRs
Suggested reviewers
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
SDK Examples Unit Test Results16 files 16 suites 2m 44s ⏱️ For more details on these failures, see this check. Results for commit fda83e4. |
Common Integration Test Results0 files 0 suites 0s ⏱️ Results for commit fda83e4. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (3)
kotlin-example/README.md (3)
14-14: Adjust indentation for consistency.The addition of the "Get execution data" subsection aligns well with the PR objectives. However, the indentation is inconsistent with other items in the list.
Please adjust the indentation to match other list items:
- - [Get execution data](#get-execution-data) + - [Get execution data](#get-execution-data)🧰 Tools
🪛 Markdownlint
14-14: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
24-24: Adjust indentation for consistency.The addition of the "Streaming events and execution data" subsection aligns well with the PR objectives. However, the indentation is inconsistent with other items in the list.
Please adjust the indentation to match other list items:
- - [Streaming events and execution data](#streaming-events-and-execution-data) + - [Streaming events and execution data](#streaming-events-and-execution-data)🧰 Tools
🪛 Markdownlint
24-24: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
129-135: LGTM: New section for Streaming Events and Execution Data.The addition of the "Streaming Events and Execution Data" section with details about using Access API subscription endpoints is informative and aligns well with the PR objectives. The bullet points provide a clear overview of the available streaming functionalities.
Consider adding a brief introductory sentence before the bullet points to provide context:
[Utilizing the Access API subscription endpoints to stream event and execution data.](src/main/kotlin/org/onflow/examples/kotlin/streaming) +This section demonstrates how to use the streaming functionality: + - Streaming events. - Streaming events and reconnecting in the event of a failure. - Streaming execution data.🧰 Tools
🪛 LanguageTool
[style] ~135-~135: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...connecting in the event of a failure. - Streaming execution data.(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (2)
- java-example/README.md (2 hunks)
- kotlin-example/README.md (4 hunks)
🧰 Additional context used
🪛 LanguageTool
java-example/README.md
[style] ~69-~69: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ollectionAccessAPIConnector.java) #### Get Execution Data [Get execution data by ...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
kotlin-example/README.md
[style] ~70-~70: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...tCollectionAccessAPIConnector.kt) #### Get Execution Data [Get execution data by ...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~135-~135: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...connecting in the event of a failure. - Streaming execution data.(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🪛 Markdownlint
kotlin-example/README.md
14-14: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
24-24: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
🔇 Additional comments (4)
java-example/README.md (2)
69-72: LGTM! New section added correctly.The new "Get Execution Data" section is well-placed and formatted consistently with other entries in the "Examples summary" table. The link to the example file follows the established pattern, and the description is concise and clear.
Clarification needed on streaming feature.
The PR objectives mention updating docs for streaming, but this is not reflected in the added section. Could you clarify if streaming should be included in this update?
Consider updating the "Unsupported Features" section.
If streaming is now supported, the "Unsupported Features" section at the end of the file may need to be updated to reflect this change.
🧰 Tools
🪛 LanguageTool
[style] ~69-~69: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ollectionAccessAPIConnector.java) #### Get Execution Data [Get execution data by ...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
69-71: Ignore LanguageTool suggestion for word repetition.The static analysis tool suggests avoiding the repetition of "Get" at the beginning of multiple sections. However, this repetition is intentional and consistent with the document's structure. Changing it would disrupt the established pattern and potentially confuse readers. Therefore, we should maintain the current format.
🧰 Tools
🪛 LanguageTool
[style] ~69-~69: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ollectionAccessAPIConnector.java) #### Get Execution Data [Get execution data by ...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
kotlin-example/README.md (2)
70-73: LGTM: New section for Get Execution Data.The addition of the "Get Execution Data" section with a link to the corresponding Kotlin code example is clear and informative. This aligns well with the PR objectives of updating documentation for added examples related to execution data.
🧰 Tools
🪛 LanguageTool
[style] ~70-~70: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...tCollectionAccessAPIConnector.kt) #### Get Execution Data [Get execution data by ...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Line range hint
1-135: Overall: Documentation updates align well with PR objectives.The changes to the
kotlin-example/README.mdfile successfully update the documentation to include new examples related to obtaining execution data and utilizing streaming through subscription endpoints. These additions enhance the clarity and usability of the documentation for users working with execution data and streaming features.Key improvements:
- Added "Get Execution Data" section with a link to the corresponding Kotlin code example.
- Added "Streaming Events and Execution Data" section with details on using Access API subscription endpoints.
- Updated the "Examples summary" section to include the new functionalities.
These changes effectively address the PR objectives and provide valuable information for users of the Flow JVM SDK.
🧰 Tools
🪛 LanguageTool
[style] ~70-~70: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...tCollectionAccessAPIConnector.kt) #### Get Execution Data [Get execution data by ...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~74-~74: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ecutionDataAccessAPIConnector.kt) #### Get Network Parameters [Get the current ne...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Description
Update docs to account for recently added examples for getting execution data and streaming via subscription endpoints.
For contributor use:
masterbranchFiles changedin the Github PR explorerSummary by CodeRabbit
New Features
Documentation