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

Update identity-iota description #889

Merged
merged 1 commit into from
Jun 14, 2022
Merged

Update identity-iota description #889

merged 1 commit into from
Jun 14, 2022

Conversation

cycraig
Copy link
Contributor

@cycraig cycraig commented Jun 14, 2022

Description of change

Brief description for the identity-iota README.md.

  • Fix broken intra-doc links.
  • Add brief module descriptions.
  • Make error module private: Error, Result already exported directly.

image

Links to any relevant issues

Addresses task of #133

Type of change

  • Bug fix (a non-breaking change which fixes an issue)
  • Enhancement (a non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation Fix

How the change has been tested

cargo doc --no-deps --open reports no warnings or errors.

Change checklist

  • I have followed the contribution guidelines for this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

@cycraig cycraig added the Documentation Improvements or additions to documentation. Excludes from changelog label Jun 14, 2022
@cycraig cycraig mentioned this pull request Jun 14, 2022
10 tasks
Copy link
Contributor

@olivereanderson olivereanderson left a comment

Choose a reason for hiding this comment

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

LGTM!

@cycraig cycraig merged commit 326f2bf into dev Jun 14, 2022
@cycraig cycraig deleted the chore/iota-client-docs branch June 14, 2022 13:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements or additions to documentation. Excludes from changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants