Minor doc nits on the new coop close reason variants

[TheBlueMatt]

No description provided.

[coderabbitai]

Walkthrough

The update enhances the ClosureReason enum in the Lightning network library, providing more detailed explanations for different shutdown scenarios. It particularly focuses on distinguishing between cooperative closures and identifying which party initiated the shutdown, aiming to improve transparency and understanding of closure events in the network.

Changes

File Path	Change Summary
lightning/src/events/mod.rs	Clarified closure reasons, distinguishing cooperative closures and initiators.

🐇✨

In the realm of code, where changes abound,
A rabbit hopped in, improvements were found.
With clarity sown, like seeds to the earth,
The network now knows, the shutdown's true worth.
🌟🐾

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit-tests for this file.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit tests for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 8d9d099 and bad2efb.

Files selected for processing (1)

• lightning/src/events/mod.rs (1 hunks)

[coderabbitai]

The comments for LegacyCooperativeClosure, CounterpartyInitiatedCooperativeClosure, and LocallyInitiatedCooperativeClosure variants in the ClosureReason enum do not provide clear, distinct explanations for each variant. This can lead to confusion about the specific circumstances under which each variant is used.

Consider refining the comments to clearly distinguish between the scenarios that lead to each cooperative closure variant being used.

[codecov-commenter]

Codecov Report

Attention: 9 lines in your changes are missing coverage. Please review.

Comparison is base (2e61d92) 89.16% compared to head (bad2efb) 89.17%.
Report is 26 commits behind head on main.

Files	Patch %	Lines
lightning/src/events/mod.rs	28.57%	5 Missing ⚠️
lightning/src/ln/functional_tests.rs	98.05%	2 Missing ⚠️
lightning/src/ln/channel.rs	94.11%	1 Missing ⚠️
lightning/src/ln/channelmanager.rs	95.45%	1 Missing ⚠️

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@           Coverage Diff            @@
##             main    #2876    +/-   ##
========================================
  Coverage   89.16%   89.17%            
========================================
  Files         116      116            
  Lines       93259    93377   +118     
  Branches    93259    93377   +118     
========================================
+ Hits        83158    83269   +111     
- Misses       7569     7577     +8     
+ Partials     2532     2531     -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.