Skip to content
This repository has been archived by the owner on Jun 21, 2020. It is now read-only.

Adding documentation and explanations to some parts of core #122

Merged
merged 7 commits into from
May 29, 2019
Merged

Conversation

elichai
Copy link
Contributor

@elichai elichai commented Apr 17, 2019

Hi, I'm writing documentation for the core code,
right now I'm focusing things that answer 2/3 of these:

  1. A non self explanatory complex code.
  2. A code that I had written.
  3. Areas in the code that right now I have most of the knowledge about them (i.e. weird rust/sgx juggling)

@elichai elichai force-pushed the docs branch 2 times, most recently from fd344ff to 9267a4d Compare April 21, 2019 13:27
@elichai elichai marked this pull request as ready for review May 19, 2019 16:34
@elichai elichai requested review from moriaab and AvishaiW May 19, 2019 16:34
@elichai
Copy link
Contributor Author

elichai commented May 22, 2019

I removed this nice explanation after all that issue was resolved in #159

//! # Serde Implementations for KM primitives.
//!
//! The only reason why we need to implement Serialize/Deserialize ourselves is because the derive macro
//! contains `extern crate serde as _serde` but we renamed serde. so that's invalid. https://github.com/serde-rs/serde/pull/1499
//! We had to rename it to support 2 different serde implementations, 1 from crates.io and another from baidu.
//!
//! I tried to keep this implementation as simple as possible and as close as possible to the auto generated one <br>
//! (you can see the autogenerated one by running
//! `cargo rustc --profile=check -- -Zunstable-options --pretty=expanded` on a code with the derive macro)

Copy link
Contributor

@AvishaiW AvishaiW left a comment

Choose a reason for hiding this comment

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

Very enriching! Thanks :)

enigma-core/app/src/cli.rs Outdated Show resolved Hide resolved
enigma-crypto/src/asymmetric.rs Outdated Show resolved Hide resolved
enigma-crypto/src/asymmetric.rs Show resolved Hide resolved
enigma-crypto/src/asymmetric.rs Outdated Show resolved Hide resolved
enigma-crypto/src/asymmetric.rs Outdated Show resolved Hide resolved
enigma-types/src/types.rs Outdated Show resolved Hide resolved
enigma-types/src/types.rs Outdated Show resolved Hide resolved
enigma-types/src/types.rs Outdated Show resolved Hide resolved
enigma-types/src/types.rs Outdated Show resolved Hide resolved
enigma-types/src/types.rs Outdated Show resolved Hide resolved
Copy link
Contributor

@AvishaiW AvishaiW left a comment

Choose a reason for hiding this comment

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

perfect!

@elichai elichai merged commit c9112fe into develop May 29, 2019
@elichai elichai deleted the docs branch May 29, 2019 14:22
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.

2 participants