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

feat(docs): document AES block cypher #74

Merged
merged 12 commits into from
Jun 9, 2024

Conversation

scriptandcompile
Copy link
Contributor

second verse, same as the first!

Copy link
Contributor Author

@scriptandcompile scriptandcompile Jun 7, 2024

Choose a reason for hiding this comment

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

I had meant to break each of these into their own commit, but I screwed up the patch add on the last one. Oopsie.

alexfertel
alexfertel previously approved these changes Jun 8, 2024
Copy link
Owner

@alexfertel alexfertel left a comment

Choose a reason for hiding this comment

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

LGTM! Only two small nits.

@@ -74,6 +143,17 @@ const INV_SBOX: [Byte; 256] = [
];

#[rustfmt::skip]
Copy link
Owner

Choose a reason for hiding this comment

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

Let's put the attribute macro below the doc comments.

Comment on lines 340 to 343
/// # Panics
///
/// This function will not panic.
///
Copy link
Owner

Choose a reason for hiding this comment

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

If a function doesn't panic, then this section can be skipped.

@alexfertel alexfertel changed the title Aes documentation feat(docs): document AES block cypher Jun 8, 2024
@alexfertel alexfertel merged commit 7044a89 into alexfertel:main Jun 9, 2024
3 checks passed
@scriptandcompile scriptandcompile deleted the aes-document branch June 13, 2024 18:09
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.

2 participants