Skip to content

Commit 21d5f12

Browse files
committed
Fix FieldIndex documentation
1 parent bcc69c1 commit 21d5f12

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

engine/src/scheme.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,9 @@ use thiserror::Error;
2929
#[error("underlying schemes do not match")]
3030
pub struct SchemeMismatchError;
3131

32-
#[derive(Debug, PartialEq, Eq, Clone, Hash, Serialize)]
33-
#[serde(tag = "kind", content = "value")]
34-
/// FieldIndex is an enum with variants [`ArrayIndex(usize)`],
35-
/// representing an index into an Array, or `[MapKey(String)`],
36-
/// representing a key into a Map.
32+
/// Enum representing either:
33+
/// * An array index with [`FieldIndex::ArrayIndex`]
34+
/// * A map key with [`FieldIndex::MapKey`]
3735
///
3836
/// ```
3937
/// #[allow(dead_code)]
@@ -42,6 +40,8 @@ pub struct SchemeMismatchError;
4240
/// MapKey(String),
4341
/// }
4442
/// ```
43+
#[derive(Debug, PartialEq, Eq, Clone, Hash, Serialize)]
44+
#[serde(tag = "kind", content = "value")]
4545
pub enum FieldIndex {
4646
/// Index into an Array
4747
ArrayIndex(u32),

0 commit comments

Comments
 (0)