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.

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

chore: documentation for record #16

Closed
wants to merge 2 commits into from

Conversation

alexanderblv
Copy link

Motivation

Closes AleoNet#2132
(Write your motivation here)

Test Plan

(Write your test plan here)

Related PRs

(Link your related PRs here)

Signed-off-by: Alexander B. <137616408+alexanderblv@users.noreply.github.com>
@vicsn
Copy link
Collaborator

vicsn commented Jun 11, 2024

Thx for the chore! Do you mind keeping the original comment (adding your new line above it)? And doing the same for the function below it? I assume the original line was useful for the original author and may be for future readers.

Signed-off-by: Alexander B. <137616408+alexanderblv@users.noreply.github.com>
@alexanderblv
Copy link
Author

Thx for the chore! Do you mind keeping the original comment (adding your new line above it)? And doing the same for the function below it? I assume the original line was useful for the original author and may be for future readers.

Done!

@alexanderblv
Copy link
Author

@vicsn It seems I don't have the rights to put this PR to merge queue. Could you do that?

@vicsn
Copy link
Collaborator

vicsn commented Jun 12, 2024

I don't either, it's not high priority so can be a while

@@ -15,6 +15,7 @@
use super::*;

impl<N: Network> Record<N, Ciphertext<N>> {
/// Determines whether the record belongs to the account.
Copy link

Choose a reason for hiding this comment

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

Suggested change
/// Determines whether the record belongs to the account.
/// Returns `true` if the given view key is the owner of the record.

@raychu86
Copy link

raychu86 commented Jul 2, 2024

Closing in favor of AleoNet#2513

@raychu86 raychu86 closed this Jul 2, 2024
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.

Documentation for Record::is_owner is misleading
3 participants