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

Add note to handle events as quickly as possible. #405

Merged
merged 1 commit into from
Nov 20, 2024

Conversation

G8XSU
Copy link
Contributor

@G8XSU G8XSU commented Nov 14, 2024

No description provided.

@G8XSU G8XSU requested a review from tnull November 14, 2024 20:20
Copy link
Collaborator

@tnull tnull left a comment

Choose a reason for hiding this comment

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

Thanks!

Do you mind adding a paragraph on general operation/usage of Node in the doc comment of struct Node, which then should also explictly state that events need to be handled? Let me know if you prefer me writing it though, happy to it in a follow-up.

@G8XSU
Copy link
Contributor Author

G8XSU commented Nov 20, 2024

adding a paragraph on general operation/usage of Node in the doc comment of struct Node, which then should also explictly state that events need to be handled? Let me know if you prefer me writing it though, happy to it in a follow-up.

I am not sure of the extent of this "how to handle events in ldk-node" doc on top of Node, I will prefer that you do it if you don't mind.
Thanks

Comment on lines +758 to +759
/// **Caution:** Users must handle events as quickly as possible to prevent a large event backlog,
/// which can increase the memory footprint of [`Node`].

Choose a reason for hiding this comment

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

Consider styling the message:

/// <div class="warning">
///
/// Users must handle events as quickly as possible to prevent a large event backlog,
/// which can increase the memory footprint of [`Node`].
///
/// </div>

https://doc.rust-lang.org/rustdoc/how-to-write-documentation.html#adding-a-warning-block

Copy link
Collaborator

Choose a reason for hiding this comment

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

We currently don't do that everywhere else, so for now landed this PR as-is. But might be an improvement to consider in the future, which we'd then however want to apply globally across all docs.

@tnull
Copy link
Collaborator

tnull commented Nov 20, 2024

I am not sure of the extent of this "how to handle events in ldk-node" doc on top of Node, I will prefer that you do it if you don't mind.

No worries!

Copy link
Collaborator

@tnull tnull left a comment

Choose a reason for hiding this comment

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

LGTM

@tnull tnull merged commit 34fd852 into lightningdevkit:main Nov 20, 2024
12 of 13 checks passed
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.

3 participants