Improve Builder and Config docs#835
Merged
tnull merged 1 commit intolightningdevkit:mainfrom Mar 20, 2026
Merged
Conversation
|
👋 Thanks for assigning @joostjager as a reviewer! |
joostjager
previously approved these changes
Mar 19, 2026
| /// | `log_dir_path` | None | | ||
| /// | `network` | Bitcoin | | ||
| /// | `listening_addresses` | None | | ||
| /// | `announcement_addresses` | None | |
Contributor
There was a problem hiding this comment.
This table is quite fragile, it must be kept in sync with the code. Not sure if it is worth keeping it?
Collaborator
Author
There was a problem hiding this comment.
I think it's worth, at least for now.
We somewhat improve the docs on `Builder` and `Config`. Namely, we expand the docs in a few areas and remove stale fields/docs. While we're at it, we also fix some typos. Co-Authored-By: HAL 9000 Signed-off-by: Elias Rohrer <dev@tnull.de>
tnull
force-pushed
the
2026-03-improve-docs
branch
from
6c26a08 to
c6308fb
Compare
Collaborator
Author
|
Force-pushed minor fixup: git diff-tree -U2 6c26a084 c6308fbb
diff --git a/src/builder.rs b/src/builder.rs
index 360fe604..b6e9e2c8 100644
--- a/src/builder.rs
+++ b/src/builder.rs
@@ -271,5 +271,4 @@ impl std::error::Error for BuildError {}
/// [`log`]: https://crates.io/crates/log
/// [Logging]: #logging
-/// [Storage]: #storage
#[derive(Debug)]
pub struct NodeBuilder { |
joostjager
approved these changes
Mar 19, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
We somewhat improve the docs on
BuilderandConfig. Namely, we expand the docs in a few areas and remove stale fields/docs.While we're at it, we also fix some typos.
Co-Authored-By: HAL 9000