Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove bdk-jvm and bdk-android examples from readmes #489

Merged
merged 1 commit into from
Apr 17, 2024

Conversation

thunderbiscuit
Copy link
Member

This PR fixes #476.

Copy link

coderabbitai bot commented Apr 15, 2024

Walkthrough

The recent updates involve removing example code snippets from the README.md files of both bdk-android and bdk-jvm projects. These changes align with the decision to eliminate detailed example usage of the org.bitcoindevkit library in Kotlin, specifically targeting the configurations and examples previously demonstrated for release 0.30.0.

Changes

File Path Change Summary
bdk-android/README.md Removed Kotlin code examples demonstrating the usage of the org.bitcoindevkit library.
bdk-jvm/README.md Removed Kotlin code examples demonstrating the usage of the org.bitcoindevkit library for 0.30.0.

Assessment against linked issues

Objective Addressed Explanation
Remove examples in bdk-jvm and bdk-android (#476)

The changes directly address the objective stated in issue #476 by removing the specified example code from the README.md files of both bdk-android and bdk-jvm. This aligns with the goal to streamline documentation and potentially shift example usage to a different format or location.


Recent Review Details

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 54f3235 and cacb78f.
Files selected for processing (2)
  • bdk-android/README.md (1 hunks)
  • bdk-jvm/README.md (1 hunks)

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?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

Actionable comments outside the diff hunks (16)
bdk-jvm/README.md (8)

Line range hint 1-1: Ensure a blank line is added after the heading for proper markdown formatting.

1a2
+

Line range hint 4-4: Ensure a blank line is added after the heading for proper markdown formatting.

4a5
+

Line range hint 28-28: Ensure a blank line is added after the heading for proper markdown formatting.

28a29
+

Line range hint 31-31: Ensure a blank line is added after the heading for proper markdown formatting.

31a32
+

Line range hint 57-57: Ensure a blank line is added after the heading for proper markdown formatting.

57a58
+

Line range hint 74-74: Ensure a blank line is added after the heading for proper markdown formatting.

74a75
+

Line range hint 75-75: Ensure a blank line is added both above and below the heading for proper markdown formatting.

74a75
+
76a78
+

Line range hint 76-76: Remove trailing spaces to clean up the markdown file.

- Depending on the JVM version you use, you might not have the JNA dependency on your classpath. The exception thrown will be 
+ Depending on the JVM version you use, you might not have the JNA dependency on your classpath. The exception thrown will be
bdk-android/README.md (8)

Line range hint 1-1: Ensure a blank line is added after the heading for proper markdown formatting.

1a2
+

Line range hint 4-4: Ensure a blank line is added after the heading for proper markdown formatting.

4a5
+

Line range hint 28-28: Ensure a blank line is added after the heading for proper markdown formatting.

28a29
+

Line range hint 33-33: Ensure a blank line is added after the heading for proper markdown formatting.

33a34
+

Line range hint 68-68: Ensure a blank line is added after the heading for proper markdown formatting.

68a69
+

Line range hint 85-85: Ensure a blank line is added after the heading for proper markdown formatting.

85a86
+

Line range hint 86-86: Ensure a blank line is added both above and below the heading for proper markdown formatting.

85a86
+
87a89
+

Line range hint 40-40: Remove trailing spaces to clean up the markdown file.

- Depending on the JVM version you use, you might not have the JNA dependency on your classpath. The exception thrown will be 
+ Depending on the JVM version you use, you might not have the JNA dependency on your classpath. The exception thrown will be


val newAddress = wallet.getAddress(AddressIndex.LastUnused)
```

### Snapshot releases
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ensure a blank line is added after the heading for proper markdown formatting.

16a17
+

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
### Snapshot releases
### Snapshot releases


val newAddress = wallet.getAddress(AddressIndex.LastUnused)
```

### Snapshot releases
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ensure a blank line is added after the heading for proper markdown formatting.

16a17
+

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
### Snapshot releases
### Snapshot releases

@thunderbiscuit thunderbiscuit requested a review from reez April 17, 2024 14:54
Copy link
Collaborator

@reez reez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK cacb78f

LGTM!

@thunderbiscuit thunderbiscuit merged commit cacb78f into bitcoindevkit:master Apr 17, 2024
2 checks passed
@thunderbiscuit thunderbiscuit deleted the fix/476 branch April 17, 2024 19:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove examples in bdk-jvm and bdk-android
2 participants