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

docs: Rectify typographical inaccuracies #75

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion arc-0001/README.md
Copy link
Contributor

Choose a reason for hiding this comment

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

This change is incorrect. The singular is ARC, the plural is ARCs, so the correct verb is "are".

Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ created: 2020-02-07

## Abstract

Aleo Request for Comments (ARCs) are protocol-level, network-level, and application-level standards for the Aleo ecosystem.
Aleo Request for Comments (ARCs) is protocol-level, network-level, and application-level standards for the Aleo ecosystem.

## Specification

Expand Down
2 changes: 1 addition & 1 deletion arc-0002/README.md
Copy link
Contributor

Choose a reason for hiding this comment

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

This change is incorrect and should be rejected. (But the description is out of date so that is a different problem.)

Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,7 @@ Checks whether `first` and `second` are not equal, halting if they are equal.

#### Description

Returns the height of the block within the finalize scope.
Returns the height of the block within the finalized scope.
Currently, block height is the only supported property.

#### Example Usage
Expand Down
4 changes: 2 additions & 2 deletions arc-0003/README.md
Copy link
Contributor

Choose a reason for hiding this comment

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

These changes are incorrect. "Aleo instructions" is the language.

Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ created: 9-29-2022

## Abstract

The purpose of this ARC is to unify syntax between Leo and Aleo instructions to make it clear what tools developers have at their disposal. We propose several breaking changes to both Leo and Aleo instructions to achieve this goal.
The purpose of this ARC is to unify syntax between Leo and Aleo's instructions to make it clear what tools developers have at their disposal. We propose several breaking changes to both Leo and Aleo's instructions to achieve this goal.

| Leo V1 —> | Leo V2 & Aleo Instructions V2 | <— Aleo Instructions V1 |
|:-------------------:|:-----------------------------:|:------------------------:|
Expand Down Expand Up @@ -64,7 +64,7 @@ The following must be defined outside the program scope in a Leo file.
* interface definitions.

### Interface Abstract Type
Interfaces are being added to both Leo and Aleo instructions to relate types that have similar implementations.
Interfaces are being added to both Leo and Aleo's instructions to relate types that have similar implementations.
Interfaces are similar to classes in object-oriented programming languages.

Interfaces can define
Expand Down
2 changes: 1 addition & 1 deletion arc-0004/README.md
Copy link
Contributor

Choose a reason for hiding this comment

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

This change is incorrect. The simple present tense "has" would not be correct because the sentence is not stating a fact, it is expressing a necessity, requiring the subjunctive mood. The correct tense is the present subjunctive, which uses "have" even for the singular.

Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ boolean.

The flagged operations are different from wrapped (e.g. `abs.w`) or
lossy (e.g. `cast.lossy`) operations. It is important that the flagged
operation have the same semantics as the current halting instruction
operation has the same semantics as the current halting instruction
except for the halting behavior and extra return value, for ease of
use by compilers.

Expand Down
2 changes: 1 addition & 1 deletion arc-0030/README.md
Copy link
Contributor

Choose a reason for hiding this comment

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

This change is correct. I recommend rejecting this PR and just changing this one word.

Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ created: 9/2/2022

## Abstract

Let's get NFTs & Tokens/DeFI working on Aleo. Currently, you can create an ERC-20/ERC-721-like program on Aleo but it is severly limited.
Let's get NFTs & Tokens/DeFI working on Aleo. Currently, you can create an ERC-20/ERC-721-like program on Aleo but it is severely limited.
The biggest limitation is that a program cannot own an NFT. This prevents these Aleo tokens from being used in: escrow, auctions, pools, etc.

In order to enable this functionality, we need an opcode in the Aleo instruction set like: `self.parent`. This opcode would be similar to `self.caller` except it would result in the address of the program who called another program.
Expand Down