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

Doc comments 1 #837

Merged
merged 6 commits into from
Nov 29, 2022
Merged

Doc comments 1 #837

merged 6 commits into from
Nov 29, 2022

Conversation

sistemd
Copy link
Contributor

@sistemd sistemd commented Nov 23, 2022

Added some doc comments explaining things I was curious about.

Please let me know if I got anything wrong 😄

@sistemd sistemd requested a review from a team as a code owner November 23, 2022 08:57
Copy link
Contributor

@MartinquaXD MartinquaXD left a comment

Choose a reason for hiding this comment

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

Love the links to the EIPs. 👍

crates/model/src/app_id.rs Outdated Show resolved Hide resolved
Copy link
Contributor

@vkgnosis vkgnosis left a comment

Choose a reason for hiding this comment

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

For some of this documentation it would be even nicer (the PR is good too, I'm just thinking out loud) if we had a place on https://cow.fi/ to link to because technical users of the exchange or the api will have the same question and it would be better to have the information consolidated in one place.

@sistemd sistemd requested a review from fedgiac November 24, 2022 18:41
Copy link
Contributor

@fedgiac fedgiac left a comment

Choose a reason for hiding this comment

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

Looks good, thanks for the additional documentation!

crates/model/src/signature.rs Outdated Show resolved Hide resolved
crates/model/src/signature.rs Outdated Show resolved Hide resolved
Copy link
Contributor

@sunce86 sunce86 left a comment

Choose a reason for hiding this comment

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

Great

@@ -6,6 +6,9 @@ use std::{
str::FromStr,
};

/// This allows arbitrary user data to be associated with an order. This type holds the
/// hash of the data, while the data itself is uploaded to IPFS. The hash is signed along with the
Copy link
Contributor

Choose a reason for hiding this comment

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

Note that this isn't enforced.

Copy link
Contributor

@nlordell nlordell left a comment

Choose a reason for hiding this comment

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

AWESOME!

@sistemd sistemd merged commit ed35294 into main Nov 29, 2022
@sistemd sistemd deleted the doc-comments-1 branch November 29, 2022 09:17
@github-actions github-actions bot locked and limited conversation to collaborators Nov 29, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants