refactor: replace examples with focused rustdoc examples #2006
Conversation
This file contains hidden or 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
3 tasks
|
Thanks for working on this one. |
kwsantiago
force-pushed
the
kwsantiago/1973-simplify-examples
branch
from
bcf49f0 to
7448a99
Compare
|
@oleonardolima thank you. CI "should" be fixed now, at least it is locally. Can we try again? |
kwsantiago
force-pushed
the
kwsantiago/1973-simplify-examples
branch
2 times, most recently
from
0e68ca5 to
9a9f9af
Compare
|
Thanks, there are some unrelated already merged commits, you probably need to do a rebase on top of master. Also, please note that we follow the conventional commits for commit messages, which would also need an update. |
kwsantiago
force-pushed
the
kwsantiago/1973-simplify-examples
branch
from
9a9f9af to
dc4e009
Compare
|
@oleonardolima ok should be ready to test CI now. Thanks! |
kwsantiago
force-pushed
the
kwsantiago/1973-simplify-examples
branch
2 times, most recently
from
1f81e2c to
fa85989
Compare
|
You'll need to perform another rebase to incorporate the CI updates/fixes, and remove the unrelated merge commit. |
kwsantiago
force-pushed
the
kwsantiago/1973-simplify-examples
branch
from
fa85989 to
6fb8acd
Compare
|
@oleonardolima should be good now, let me know if there is anything else here. |
Remove standalone examples in favor of focused, contextual rustdoc examples that are easier to maintain and provide better documentation. This makes the codebase more maintainable while improving the developer experience with examples that are tested alongside the code they document.
kwsantiago
force-pushed
the
kwsantiago/1973-simplify-examples
branch
from
86defb3 to
92ba283
Compare
kwsantiago
changed the title
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.
Closes #1973
Changes
/examplesfolder containing CLI-heavy examplesIndexedTxGraph::new()- graph initializationBdkElectrumClient::new()- client creationBdkElectrumClient::sync()- blockchain syncBdkElectrumClient::full_scan()- wallet restorationTxGraph::insert_tx()- transaction insertionTxGraph::balance()- balance calculationTxGraph::filter_chain_unspents()- UTXO retrievalKeychainTxOutIndex::reveal_next_spk()- address generationKeychainTxOutIndex::insert_descriptor()- descriptor setupIndexedTxGraph::apply_block_relevant()- block processingEsploraExt::full_scan()- Esplora wallet scanningCargo.tomlworkspace membersRationale
The previous examples contained 300+ lines of CLI boilerplate that obscured the core BDK functionality. The new rustdoc examples are 10-15 lines each and focus purely on API usage, making them much easier for developers to understand and follow.
The maintained
bdk-clitool serves as the comprehensive CLI example.