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.

Sign up for GitHub

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

Jump to bottom

Improve Option documentation and add MaybeSome function #9222

Merged
merged 2 commits into from
Oct 30, 2024
Merged

Improve Option documentation and add MaybeSome function #9222

merged 2 commits into from
Oct 30, 2024

Conversation

ffranr
Copy link
Collaborator

@ffranr ffranr commented Oct 25, 2024

Fix Option doc comment and add MaybeSome function for pointer conversion.

@ffranr ffranr requested a review from guggero October 25, 2024 15:33
@ffranr ffranr self-assigned this Oct 25, 2024
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 25, 2024 •
edited
Loading

Important

Review skipped

Auto reviews are limited to specific labels.

🏷️ Labels to auto review (1)
  • llm-review

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

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
🪧 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>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • 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 testing code 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • 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/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

guggero
guggero approved these changes Oct 25, 2024
View reviewed changes
Copy link
Collaborator

@guggero guggero left a comment

Choose a reason for hiding this comment

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

Thanks, LGTM 🎉

dstadulis
dstadulis approved these changes Oct 29, 2024
View reviewed changes
fn/option.go Outdated
Comment on lines 31 to 32
// MaybeSome : *A -> Option[A].
func MaybeSome[A any](a *A) Option[A] {
Copy link
Collaborator

Choose a reason for hiding this comment

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

clean! IIUC, Seems this structure will reduce complexity in handling the inputs within larger functions

ProofOfKeags
ProofOfKeags requested changes Oct 29, 2024
View reviewed changes
fn/option.go Outdated
// MaybeSome constructs an option from a pointer.
//
// MaybeSome : *A -> Option[A].
func MaybeSome[A any](a *A) Option[A] {
Copy link
Collaborator

Choose a reason for hiding this comment

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

This function is good. However, please rename it to something approximating the below list. "Maybe" does not have precedent to mean anything and I think there are more intuitive names for this signature.

  • OptionFromPtr
  • PtrToOption
  • DerefOrNone

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I've gone with OptionFromPtr in the latest commits.

Thanks for taking a look.

@ffranr
fn: add OptionFromPtr function
c49d038 
Add a function `OptionFromPtr` that constructs an `Option` from a
pointer. The function signature is: `OptionFromPtr : *A -> Option[A]`.

This utility has proven useful in the taproot-assets project.
@ffranr
fn: fix documentation comment for Option
71298f7 
Remove the type generic from the `Option` type struct in the doc
comment.
@guggero guggero merged commit 4c48402 into lightningnetwork:master Oct 30, 2024
27 of 34 checks passed
@guggero
Copy link
Collaborator

guggero commented Oct 30, 2024

I pushed a new tag fn/v1.2.4 for this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dstadulis dstadulis dstadulis approved these changes

@ProofOfKeags ProofOfKeags ProofOfKeags approved these changes

@guggero guggero guggero approved these changes

Assignees

@ffranr ffranr

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@ffranr @guggero @ProofOfKeags @dstadulis