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

Applying renamings to documentation comments #104

Closed
Skyge opened this issue Nov 13, 2020 · 4 comments
Closed

Applying renamings to documentation comments #104

Skyge opened this issue Nov 13, 2020 · 4 comments

Comments

@Skyge
Copy link
Contributor

Skyge commented Nov 13, 2020

Glad to see have a new release version, and I am trying to use the latest version right now, but I am confused about this comments: To use this library you can add a using SafeERC20 for IERC20; statement to your contract,
Should it be using SafeERC20Upgradeable for IERC20Upgradeable;

@frangio
Copy link
Contributor

frangio commented Nov 13, 2020

Hi @Skyge. Yes, indeed. While the code is converted automatically, the documentation comments are kept the same. It would be difficult for us to do that automatically, but we may be able to work something out for the docs site.

@frangio frangio changed the title Comment error Applying renamings to documentation comments Nov 13, 2020
@frangio
Copy link
Contributor

frangio commented Nov 13, 2020

As explained in Using with Upgrades:

The package replicates the structure of the main OpenZeppelin Contracts package, but every file and contract has the suffix Upgradeable.

@stefek99
Copy link
Contributor

Thank you very much for renaming the package!

  • OpenZeppelin/openzeppelin-contracts
  • OpenZeppelin/openzeppelin-contracts-upgradeable - logical, upgradeable

"ethereum package" was totally unintuitive

import "@openzeppelin/contracts-ethereum-package/contracts/presets/ERC20PresetMinterPauser.sol";

@frangio
Copy link
Contributor

frangio commented Dec 2, 2020

Closing in favor of #105.

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

No branches or pull requests

3 participants