Skip to content

doc: fix warning documentation HTML tags #2486

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.

Sign up for GitHub

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

Open
jasonaowen wants to merge 2 commits into
base: master
Choose a base branch
from
+13 −10
Open

doc: fix warning documentation HTML tags #2486

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f68b50a
cipher: fix warning docs on `StreamCipher`
jasonaowen Aug 12, 2026
3932fa4
elliptic-curve: fix warning doc HTML tags
jasonaowen Aug 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions cipher/src/stream.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ pub trait StreamCipher {

/// Apply keystream to `inout` without checking for keystream repetition.
///
/// <div><class = "warning">
/// <b>WARNING<b>
/// <div class="warning">
/// <b>WARNING</b>
///
/// This method should be used with extreme caution! Triggering keystream repetition can expose
/// the stream cipher to chosen plaintext attacks.
Expand All @@ -59,8 +59,8 @@ pub trait StreamCipher {

/// Apply keystream to `buf` without checking for keystream repetition.
///
/// <div><class = "warning">
/// <b>WARNING<b>
/// <div class="warning">
/// <b>WARNING</b>
///
/// This method should be used with extreme caution! Triggering keystream repetition can expose
/// the stream cipher to chosen plaintext attacks.
Expand All @@ -69,8 +69,8 @@ pub trait StreamCipher {

/// Apply keystream to data behind `buf` without checking for keystream repetition.
///
/// <div><class = "warning">
/// <b>WARNING<b>
/// <div class="warning">
/// <b>WARNING</b>
///
/// This method should be used with extreme caution! Triggering keystream repetition can expose
/// the stream cipher to chosen plaintext attacks.
Expand All @@ -88,8 +88,8 @@ pub trait StreamCipher {
/// # Errors
/// Returns [`NotEqualError`] if the `input` and `output` buffers have different lengths.
///
/// <div><class = "warning">
/// <b>WARNING<b>
/// <div class="warning">
/// <b>WARNING</b>
///
/// This method should be used with extreme caution! Triggering keystream repetition can expose
/// the stream cipher to chosen plaintext attacks.
Expand Down
4 changes: 3 additions & 1 deletion elliptic-curve/src/ops.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,8 @@ pub trait BatchInvert: Field {
/// <b>Security Warning</b>
///
/// This should NOT be used on secret values!
/// </b>
///
/// </div>
fn batch_invert_in_place_vartime(elements: &mut [Self], scratch_space: &mut [Self]) -> Self {
// Call the constant-time implementation by default
Self::batch_invert_in_place(elements, scratch_space)
Expand Down Expand Up @@ -95,6 +96,7 @@ where
///
/// Variable-time operations should only be used on non-secret values, and may potentially leak
/// secret values!
///
/// </div>
pub trait MulVartime<Rhs = Self>: Mul<Rhs> {
/// Multiply `self` by `rhs` in variable-time.
Expand Down
3 changes: 2 additions & 1 deletion elliptic-curve/src/point.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,8 @@ pub trait BatchNormalize<Points: ?Sized> {
/// <b>Security Warning</b>
///
/// This should NOT be used on points which represent secrets!
/// </b>
///
/// </div>
fn batch_normalize_vartime(points: &Points) -> Self::Output {
// Call the constant-time implementation by default
Self::batch_normalize(points)
Expand Down