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

Update self.caller and self.signer documentation #288

Merged
merged 7 commits into from
Oct 4, 2023

Conversation

craigjson
Copy link
Contributor

@craigjson craigjson commented Oct 2, 2023

Makes the following updates to the .aleo documentation

  1. Updates existing references to self.caller to reference self.signer
  2. Adds a section for self.caller explaining the new feature
  3. Provides examples of the difference between self.signer and self.caller

One question, with this update, there will be inconsistency between the Leo and Aleo documentation. Namely, that because Leo has not yet implemented the new self.caller, the documentation that refers to it https://developer.aleo.org/leo/language#selfcaller will actually be talking about self.signer in Aleo instructions. I worry this may cause some confusion. We could remove this section in the Leo docs for now, curious to your thoughts @collinc97

Part of: https://github.com/AleoHQ/snarkVM/pull/2020

@craigjson craigjson requested review from a team and collinc97 October 2, 2023 20:29
Copy link
Contributor

@collinc97 collinc97 left a comment

Choose a reason for hiding this comment

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

Thanks for the PR @craigjson

I think the motivating example is a good way to introduce this command.
Do you think developers will copy and paste this example into their projects?
Do you have additional snarkvm CLI commands that you ran to test the functionality?

documentation/aleo/03_language.md Outdated Show resolved Hide resolved
documentation/aleo/03_language.md Outdated Show resolved Hide resolved
documentation/aleo/03_language.md Outdated Show resolved Hide resolved
documentation/aleo/03_language.md Outdated Show resolved Hide resolved
documentation/aleo/03_language.md Outdated Show resolved Hide resolved
documentation/aleo/03_language.md Outdated Show resolved Hide resolved
documentation/aleo/03_language.md Outdated Show resolved Hide resolved
documentation/aleo/03_language.md Outdated Show resolved Hide resolved
documentation/aleo/03_language.md Outdated Show resolved Hide resolved
documentation/aleo/03_language.md Outdated Show resolved Hide resolved
@collinc97
Copy link
Contributor

Makes the following updates to the .aleo documentation

  1. Updates existing references to self.caller to reference self.signer
  2. Adds a section for self.caller explaining the new feature
  3. Provides examples of the difference between self.signer and self.caller

One question, with this update, there will be inconsistency between the Leo and Aleo documentation. Namely, that because Leo has not yet implemented the new self.caller, the documentation that refers to it https://developer.aleo.org/leo/language#selfcaller will actually be talking about self.signer in Aleo instructions. I worry this may cause some confusion. We could remove this section in the Leo docs for now, curious to your thoughts @collinc97

Part of: AleoHQ/snarkVM#2020

I expect the feature parity between Leo and Aleo Instructions to be resolved this week.
For now you could add an Admonition that makes it clear for people that there is a difference.

@craigjson
Copy link
Contributor Author

Thanks for the PR @craigjson

I think the motivating example is a good way to introduce this command. Do you think developers will copy and paste this example into their projects? Do you have additional snarkvm CLI commands that you ran to test the functionality?

A developer can copy and paste this example, however I'd say it's fairly academic and limited in it's usability for a production program. It reminds me of an example a professor would use to show how OOP Inheritance works.

I added some steps to create a project and run this on the CLI to generate the output that is provided

@craigjson craigjson requested a review from collinc97 October 3, 2023 20:54
@collinc97
Copy link
Contributor

Hi @craigjson can you see my latest PR against this one #291

@craigjson
Copy link
Contributor Author

Hi @craigjson can you see my latest PR against this one #291

merged

Copy link
Contributor

@collinc97 collinc97 left a comment

Choose a reason for hiding this comment

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

LGTM

@collinc97 collinc97 merged commit ff218e1 into master Oct 4, 2023
2 checks passed
@collinc97 collinc97 deleted the craigjson/self_signer_self_parent_docs branch October 4, 2023 18:25
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.

2 participants