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

docs: Fix unclosed HTML tags errors #1212

Merged
merged 1 commit into from
Oct 13, 2022
Merged

docs: Fix unclosed HTML tags errors #1212

merged 1 commit into from
Oct 13, 2022

Conversation

thanethomson
Copy link
Member

Closes #1211

  • Referenced an issue explaining the need for the change
  • Updated all relevant documentation in docs
  • Updated all code comments where relevant
  • Wrote tests
  • Added entry in .changelog/

Signed-off-by: Thane Thomson <connect@thanethomson.com>
@thanethomson thanethomson merged commit e830f85 into main Oct 13, 2022
@thanethomson thanethomson deleted the thane/fix-docs branch October 13, 2022 18:00
Copy link
Contributor

@mzabaluev mzabaluev left a 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
Copy link
Contributor

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>`
Copy link
Contributor

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:

Suggested change
/// 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>`
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
/// Serialize into `Option<base64string>`, deserialize from `Option<base64string>`
/// Serialize into and deserialize from an optional _base64string_.

thanethomson added a commit that referenced this pull request Oct 21, 2022
Signed-off-by: Thane Thomson <connect@thanethomson.com>
mzabaluev pushed a commit that referenced this pull request Oct 22, 2022
Signed-off-by: Thane Thomson <connect@thanethomson.com>

Signed-off-by: Thane Thomson <connect@thanethomson.com>
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.

docs: Build fails
2 participants