You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Document better optional features (data_loss_protect, upfront_shutdown_script,...) #438
Post #428 merge, would be great to document FeatureContext* setters (lightning/src/ln/msgs.rs), I don't think optional features are documented anyway in the current codebase beyond references to BOLT.
I believe we already have the setters documented in a sense, but indeed we don't currently have docs which indicate the list of features that we support and what is optional/required/etc. We should probably put it in the module-level documentation in lightning/src/ln/features.rs, and, yes, its still up for grabs :)
I believe we already have the setters documented in a sense, but indeed we don't currently have docs which indicate the list of features that we support and what is optional/required/etc. We should probably put it in the module-level documentation in lightning/src/ln/features.rs, and, yes, its still up for grabs :)
What features are worth documenting in lightning/src/ln/features.rs from lightning/src/ln/msgs.rs? I.e., should I group the structs in lightning/src/ln/msgs.rs into features by their feature flags as shown in BOLT #9: Assigned Feature Flags? Not sure if this question makes sense.
Not sure why you mention msgs.rs - I was mostly thinking about documenting the set of features implemented in LDK, ie just in features.rs talking about the features that we set and what they do.
That makes sense. In the context of ariard's initial comment on this issue, I thought your comment referred to specific features in msgs.rs that should be documented in features.rs. Thanks for the clarification!
Yea, it's a bit confusing because the code has changed a good bit since this issue was opened. But safe to just treat it as "need better docs on what features do and would be good to document them in some global place in terms of 'what LDK supports'".
Activity
mattfaltyn commentedon May 19, 2022
@ariard would love to work on this if it's still available!
TheBlueMatt commentedon May 19, 2022
I believe we already have the setters documented in a sense, but indeed we don't currently have docs which indicate the list of features that we support and what is optional/required/etc. We should probably put it in the module-level documentation in
lightning/src/ln/features.rs, and, yes, its still up for grabs :)mattfaltyn commentedon May 27, 2022
What features are worth documenting in
lightning/src/ln/features.rsfromlightning/src/ln/msgs.rs? I.e., should I group thestructsinlightning/src/ln/msgs.rsinto features by their feature flags as shown in BOLT #9: Assigned Feature Flags? Not sure if this question makes sense.TheBlueMatt commentedon May 27, 2022
Not sure why you mention
msgs.rs- I was mostly thinking about documenting the set of features implemented in LDK, ie just infeatures.rstalking about the features that we set and what they do.mattfaltyn commentedon May 28, 2022
That makes sense. In the context of ariard's initial comment on this issue, I thought your comment referred to specific features in
msgs.rsthat should be documented infeatures.rs. Thanks for the clarification!TheBlueMatt commentedon May 29, 2022
Yea, it's a bit confusing because the code has changed a good bit since this issue was opened. But safe to just treat it as "need better docs on what features do and would be good to document them in some global place in terms of 'what LDK supports'".