Skip to content

Proposal: Update description of the crypto API to make it more user friendly#181

Merged
jolly-fellow merged 3 commits intomainfrom
crypto_api_update_proposal
May 23, 2023
Merged

Proposal: Update description of the crypto API to make it more user friendly#181
jolly-fellow merged 3 commits intomainfrom
crypto_api_update_proposal

Conversation

@jolly-fellow
Copy link
Contributor

@jolly-fellow jolly-fellow commented May 19, 2023

The crypto API description was updated to make it more user friendly

The crypto API description was updated to make it more user friendly corresponding to issue #176

API Changes

  • API Changes

Documentation Additions

  • [ x] Documentation Additions


In `v3.0`, `C` format was supported; in `v3.1` and newer versions, `C++` format was added for better data abstraction.
Antelope blockchain implements cryptographic functions for operations on points on elliptic curves, computing hashes
of big integers, Big integer modular exponentiation, and other operations useful for implementing
Copy link
Contributor

Choose a reason for hiding this comment

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

Change Big to big

@jolly-fellow jolly-fellow changed the title Proposal: Update the crypto API to make it more user friendly Proposal: Update description of the crypto API to make it more user friendly May 19, 2023
@jolly-fellow jolly-fellow requested a review from linh2931 May 19, 2023 18:50
@jolly-fellow jolly-fellow linked an issue May 22, 2023 that may be closed by this pull request
Copy link
Contributor

@ScottBailey ScottBailey left a comment

Choose a reason for hiding this comment

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

I've suggested a few grammatical changes, but otherwise this looks great!!

Thanks!!!

a few grammatical changes were made

Co-authored-by: Scott B <Scott@TheBaileyFamily.org>
@jolly-fellow jolly-fellow requested a review from ScottBailey May 22, 2023 21:08
@jolly-fellow jolly-fellow merged commit aa6efda into main May 23, 2023
@jolly-fellow jolly-fellow deleted the crypto_api_update_proposal branch May 23, 2023 14:17
@ericpassmore
Copy link
Contributor

Note:start
group: CLEANCODE
category: DOCUMENTATION
summary: Update of crypto API descriptions.
Note: end

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.

Make description of the crypto primitives more user friendly.

4 participants