-
Notifications
You must be signed in to change notification settings - Fork 207
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
docs: Fix unclosed HTML tags errors #1212
Conversation
Signed-off-by: Thane Thomson <connect@thanethomson.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good fix, I only have a few stylistic suggestions to improve these docs while you are at it.
@@ -18,7 +18,7 @@ pub mod hexstring { | |||
.map_err(serde::de::Error::custom) | |||
} | |||
|
|||
/// Serialize from T into hexstring | |||
/// Serialize from `T` into hexstring |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd just say "a byte slice", it's generic.
@@ -68,14 +68,14 @@ pub mod base64string { | |||
} | |||
} | |||
|
|||
/// Serialize into Vec<base64string>, deserialize from Vec<base64string> | |||
/// Serialize into `Vec<base64string>`, deserialize from `Vec<base64string>` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To avoid pseudo type references and generalize over serde formats:
/// Serialize into `Vec<base64string>`, deserialize from `Vec<base64string>` | |
/// Serialize into and deserialize from a sequence of _base64string_. |
@@ -103,14 +103,14 @@ pub mod vec_base64string { | |||
} | |||
} | |||
|
|||
/// Serialize into Option<base64string>, deserialize from Option<base64string> | |||
/// Serialize into `Option<base64string>`, deserialize from `Option<base64string>` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/// Serialize into `Option<base64string>`, deserialize from `Option<base64string>` | |
/// Serialize into and deserialize from an optional _base64string_. |
Signed-off-by: Thane Thomson <connect@thanethomson.com>
Signed-off-by: Thane Thomson <connect@thanethomson.com> Signed-off-by: Thane Thomson <connect@thanethomson.com>
Closes #1211
.changelog/