lnd icon indicating copy to clipboard operation
lnd copied to clipboard

Add new functions to the fn package

Open Chinwendu20 opened this issue 1 year ago • 3 comments

Change Description

This adds new functions to the fn packages. Changes include:

  • A new file for map functions accompanied with a test file.
  • Added new functions for slice accompanied with test.

This is required for this PR: https://github.com/lightningnetwork/lnd/pull/8516/

Steps to Test

Steps for reviewers to follow to test the change.

Pull Request Checklist

Testing

  • [ ] Your PR passes all CI checks.
  • [ ] Tests covering the positive and negative (error paths) are included.
  • [ ] Bug fixes contain tests triggering the bug to prevent regressions.

Code Style and Documentation

📝 Please see our Contribution Guidelines for further guidance.

Chinwendu20 avatar May 05 '24 20:05 Chinwendu20

[!IMPORTANT]

Auto Review Skipped

Auto reviews are disabled on this repository.

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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.
  • 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.

coderabbitai[bot] avatar May 05 '24 20:05 coderabbitai[bot]

Does this need a release note? could not find anything about fn in the other release notes.

Chinwendu20 avatar May 05 '24 20:05 Chinwendu20

Are you aware of this package: https://pkg.go.dev/golang.org/x/exp/maps? Most of what you've added is already here.

Roasbeef avatar May 06 '24 18:05 Roasbeef

Are you aware of this package: https://pkg.go.dev/golang.org/x/exp/maps? Most of what you've added is already here.

Not really, I just checked it and it seems that is that is the case. Thanks for pointing it out would be closing this now.

Chinwendu20 avatar May 07 '24 14:05 Chinwendu20

Thanks for the feedback @ProofOfKeags. I would rework and open another PR. Oops just looked down while typing this and realised that I can reopen this PR.

Chinwendu20 avatar May 08 '24 21:05 Chinwendu20

Thanks.

Do I have to wait for a new release of this package to use it?

Looked at the comments on my tlv PR and it seems like I would just wait. I think maintainers are the ones to make releases.

Chinwendu20 avatar May 10 '24 14:05 Chinwendu20

I pushed a new tag called fn/v1.0.6. So in the PR that depends on it, you can update the github.com/lightningnetwork/lnd/fn dependency to v1.0.6 in go.mod.

guggero avatar May 10 '24 15:05 guggero