Skip to content

docs: fix typos in task descriptions and NatSpec #171

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.

Sign up for GitHub

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

Open
phessophissy wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: fix typos in task descriptions and NatSpec #171

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions contracts/beanstalk/facets/metadata/MetadataFacet.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import {LibTokenSilo} from "contracts/libraries/Silo/LibTokenSilo.sol";
* @notice MetadataFacet is a contract that provides metadata for Pinto ERC1155 deposits,
* as well as other auxiliary functions related to ERC1155 deposits.
*
* @dev Deposits are represented by a uint256, which is the concatination of the token address and the stem.
* @dev Deposits are represented by a uint256, which is the concatenation of the token address and the stem.
*/
contract MetadataFacet is MetadataImage {
using Strings for uint256;
Expand All @@ -29,7 +29,7 @@ contract MetadataFacet is MetadataImage {
* @param depositId - the id of the deposit
* @dev the URI is a base64 encoded JSON object that contains the metadata and base64 encoded svg.
* Deposits are stored as a mapping of a uint256 to a Deposit struct.
* ERC20 deposits are represented by the concatination of the token address and the stem. (20 + 12 bytes).
* ERC20 deposits are represented by the concatenation of the token address and the stem. (20 + 12 bytes).
*/
function uri(uint256 depositId) external view returns (string memory) {
(address token, int96 stem) = LibBytes.unpackAddressAndStem(depositId);
Expand Down
12 changes: 6 additions & 6 deletions tasks/protocol-improvements.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ const {
} = require("../test/hardhat/utils/constants.js");

module.exports = function () {
task("PI-1", "Deploys Pinto improvment set 1").setAction(async function () {
task("PI-1", "Deploys Pinto improvement set 1").setAction(async function () {
const mock = false;
let owner;
if (mock) {
Expand Down Expand Up @@ -72,7 +72,7 @@ module.exports = function () {
});
});

task("PI-2", "Deploys Pinto improvment set 2").setAction(async function () {
task("PI-2", "Deploys Pinto improvement set 2").setAction(async function () {
const mock = false;
let owner;
if (mock) {
Expand All @@ -96,7 +96,7 @@ module.exports = function () {
});
});

task("PI-3", "Deploys Pinto improvment set 3").setAction(async function () {
task("PI-3", "Deploys Pinto improvement set 3").setAction(async function () {
const mock = true;
let owner;
if (mock) {
Expand Down Expand Up @@ -156,7 +156,7 @@ module.exports = function () {
});
});

task("PI-4", "Deploys Pinto improvment set 4").setAction(async function () {
task("PI-4", "Deploys Pinto improvement set 4").setAction(async function () {
const mock = true;
let owner;
if (mock) {
Expand Down Expand Up @@ -195,7 +195,7 @@ module.exports = function () {
});
});

task("PI-5", "Deploys Pinto improvment set 5").setAction(async function () {
task("PI-5", "Deploys Pinto improvement set 5").setAction(async function () {
const mock = true;
let owner;
if (mock) {
Expand Down Expand Up @@ -244,7 +244,7 @@ module.exports = function () {
});
});

task("PI-6", "Deploys Pinto improvment set 6").setAction(async function () {
task("PI-6", "Deploys Pinto improvement set 6").setAction(async function () {
const mock = true;
let owner;
if (mock) {
Expand Down