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

Feature: docs, test improvement, inline comments #10

Merged
merged 4 commits into from
Oct 25, 2023

Conversation

alexanderem49
Copy link
Owner

  • Contracts:
    • In line comments
  • Tests:
    • In line comments
    • Improve coverage of integration test
  • Documentation
    • Component page
      • non-upgradable version
        • extend description of contract logic and methods imported/exported

Copy link
Collaborator

@Jorge-Lopes Jorge-Lopes left a comment

Choose a reason for hiding this comment

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

Some updates are requested.
The suggestions made to the simpleExchange are related to the upgradableSimpleExchange as well.
It seems to be some confusion on the term seat and offer on both comments and the contract as well. Maybe we should update the contract terminology on this regards.

The component page I will review in more detail in the future

contract/src/simpleExchange.js Outdated Show resolved Hide resolved
contract/src/simpleExchange.js Outdated Show resolved Hide resolved
contract/src/simpleExchange.js Outdated Show resolved Hide resolved
contract/src/simpleExchange.js Outdated Show resolved Hide resolved
contract/src/simpleExchange.js Outdated Show resolved Hide resolved
contract/src/simpleExchange.js Outdated Show resolved Hide resolved
contract/src/simpleExchange.js Outdated Show resolved Hide resolved
contract/src/simpleExchange.js Outdated Show resolved Hide resolved
contract/src/upgradableSimpleExchange.js Outdated Show resolved Hide resolved
contract/src/upgradableSimpleExchange.js Outdated Show resolved Hide resolved
Copy link
Collaborator

@Jorge-Lopes Jorge-Lopes left a comment

Choose a reason for hiding this comment

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

LGTM

@Jorge-Lopes Jorge-Lopes merged commit cb54282 into develop Oct 25, 2023
0 of 2 checks passed
@Jorge-Lopes Jorge-Lopes deleted the feature/docs-test-improvement branch November 22, 2023 12:24
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