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

Make monitor update name public #3376

Merged

Conversation

yellowred
Copy link
Contributor

These structs are meant for MonitoringUpdatingPersister implementation, but some external implementations may still reuse them, so going to make them public.

@yellowred yellowred force-pushed the yellowred/monitor_update_name_pub branch from 6866d3a to ca0295b Compare October 17, 2024 23:39
@TheBlueMatt
Copy link
Collaborator

Making these public seems reasonable, but to do so we should substantially improve the documentation on them - what are they used for, how is the conversion done, why is it done, why would a user want to use these structs directly, etc

@yellowred yellowred force-pushed the yellowred/monitor_update_name_pub branch 2 times, most recently from cd4714f to 25e4107 Compare October 21, 2024 23:17
@yellowred
Copy link
Contributor Author

@TheBlueMatt Added docs for all the structs and methods with examples. I did not mention specific details of custom persistence implementation, for example that it should impl Persist and use KVStore, leaving it to a user to figure out if they need it or not.

@yellowred yellowred force-pushed the yellowred/monitor_update_name_pub branch from 25e4107 to b42a77e Compare October 22, 2024 01:19
@yellowred
Copy link
Contributor Author

Fixed formatting.

These structs are meant for MonitoringUpdatingPersister implementation, but some
external implementations may still reuse them, so going to make them public.
@yellowred yellowred force-pushed the yellowred/monitor_update_name_pub branch from b42a77e to 01529dc Compare October 22, 2024 17:04
Copy link
Collaborator

@TheBlueMatt TheBlueMatt left a comment

Choose a reason for hiding this comment

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

Nice docs! Thanks.

@TheBlueMatt TheBlueMatt merged commit b2bcfca into lightningdevkit:main Oct 22, 2024
17 of 19 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.

2 participants