feat: fix docs and bad namings in API #2620
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dirvine
reviewed
Jan 10, 2025
| @@ -22,7 +22,7 @@ pub struct GraphEntry { | |||
| pub owner: PublicKey, | |||
| pub parents: Vec<PublicKey>, | |||
| pub content: GraphContent, | |||
| pub outputs: Option<Vec<(PublicKey, GraphContent)>>, | |||
| pub outputs: Vec<(PublicKey, GraphContent)>, | |||
| /// signs the above 4 fields with the owners key | |||
There was a problem hiding this comment.
The reason for option here is that some patterns we do not have outputs, only Parent. i.e. when used as a file change history the GraphEntry can only go backwards. So the content is a direct or whatever and changes with each entry. There are no outputs in that pattern though.
dirvine
reviewed
Jan 10, 2025
| @@ -1,9 +1,9 @@ | |||
| import { LinkedListOptions, PaymentOption } from './types'; | |||
There was a problem hiding this comment.
we should also rename this file
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.