Skip to content

Clean up docs on public chan_utils methods to be more useful #940

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

Merged
merged 1 commit into from
Jun 8, 2021

Conversation

TheBlueMatt
Copy link
Collaborator

No description provided.

@codecov
Copy link

codecov bot commented Jun 7, 2021

Codecov Report

Merging #940 (2291457) into main (3996eaa) will increase coverage by 0.00%.
The diff coverage is 100.00%.

❗ Current head 2291457 differs from pull request most recent head 8cdc855. Consider uploading reports for the commit 8cdc855 to get more accurate results
Impacted file tree graph

@@           Coverage Diff           @@
##             main     #940   +/-   ##
=======================================
  Coverage   90.59%   90.60%           
=======================================
  Files          60       60           
  Lines       30393    30393           
=======================================
+ Hits        27536    27538    +2     
+ Misses       2857     2855    -2     
Impacted Files Coverage Δ
lightning/src/ln/chan_utils.rs 97.43% <100.00%> (ø)
lightning/src/ln/functional_tests.rs 97.20% <0.00%> (+0.03%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3996eaa...8cdc855. Read the comment docs.

@devrandom
Copy link
Member

devrandom commented Jun 7, 2021

Lightning-signer is actually using these for test purposes, but I agree it doesn't make a lot of sense to expose and we can copy the small amount of code to our repo.

@TheBlueMatt
Copy link
Collaborator Author

Lightning-signer is actually using these for test purposes

Alright, no big deal, we can fix the docs instead of un-exposing :).

@TheBlueMatt TheBlueMatt changed the title Un-expose two functions which aren't useful and have no (real) docs Clean up docs on public chan_utils methods to be more useful Jun 7, 2021
Copy link
Contributor

@valentinewallace valentinewallace left a comment

Choose a reason for hiding this comment

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

Maybe both could use something about when/why you'd want to call them?

Copy link
Contributor

@jkczyz jkczyz left a comment

Choose a reason for hiding this comment

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

Looks good after squash

@TheBlueMatt
Copy link
Collaborator Author

Squashed without changes:

$ git diff-tree -U1 22914572f 8cdc855f0
$

@TheBlueMatt TheBlueMatt merged commit a8038a8 into lightningdevkit:main Jun 8, 2021
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.

4 participants