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

chore(docs): updated the docs for Delete Edit and Test Icons #305

Closed
wants to merge 5 commits into from

Conversation

Cronus1007
Copy link
Contributor

@Cronus1007 Cronus1007 commented Mar 15, 2021

Closes #271

Changes

  • Updated the Docs for ui-contract-editor regarding the Clause Props Object
  • Linked README.md file of ui-contract-editor with that of contract-editor

Related Issues

Author Checklist

  • Ensure you provide a DCO sign-off for your commits using the --signoff option of git commit.
  • Vital features and changes captured in unit and/or integration tests
  • Commits messages follow AP format
  • Extend the documentation, if necessary
  • Merging to master from fork:branchname
  • Manual accessibility test performed
    • Keyboard-only access, including forms
    • Contrast at least WCAG Level A
    • Appropriate labels, alt text, and instructions

Copy link
Member

@jolanglinais jolanglinais left a comment

Choose a reason for hiding this comment

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

Please rebase to remove merge commits.

Also, needs investigation by @accordproject/maintainers-ui.

Copy link
Member

@jolanglinais jolanglinais left a comment

Choose a reason for hiding this comment

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

Can you rebase? I had updated some of this in #324

I'm not sure I understand the Overview section:

The Contract Editor tool gives you the ability to examine and edit class contracts in a context that is isolated from the full class text. In other words, when you use the Contract Editor tool, you see and edit the contracts without having to work around other elements of the software text such as implementation.For routines, you can edit pre- and postconditions, and for classes, you can edit class invariants. The tool provides views of inherited contracts as well as immediate ones.

What are these?

  • Class contract
  • Class text
  • Class invariants
  • Implementation (an element of the software text?)
  • Inherited contract
  • Immediate contract

@jolanglinais jolanglinais added the Type: Documentation 📝 Information and guides for clarification label Apr 2, 2021
@Cronus1007
Copy link
Contributor Author

Cronus1007 commented Apr 2, 2021

Can you rebase? I had updated some of this in #324

I'm not sure I understand the Overview section:

The Contract Editor tool gives you the ability to examine and edit class contracts in a context that is isolated from the full class text. In other words, when you use the Contract Editor tool, you see and edit the contracts without having to work around other elements of the software text such as implementation.For routines, you can edit pre- and postconditions, and for classes, you can edit class invariants. The tool provides views of inherited contracts as well as immediate ones.

What are these?

  • Class contract
  • Class text
  • Class invariants
  • Implementation (an element of the software text?)
  • Inherited contract
  • Immediate contract

@irmerk I have resolved merge conflicts plus changed a little bit of overview as well.This text has been completely modified since here I gave an overview of Class Contract which was wrong.Thanks for pointing it out.

@jolanglinais
Copy link
Member

Closing because I think the Overview of Contract Editor Tool section is explained in other locations like the techdocs repository, the Overview of Clause Props Object section is explained just after this addition, and the last section is handled in another PR..

@Cronus1007
Copy link
Contributor Author

@irmerk So any updates about the issue #271.This one can also be closed since you added the required code block which got erased to resolve the merge conflicts.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation 📝 Information and guides for clarification
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs for Delete Edit and Test Icons
2 participants