Skip to content

Commit 3c412b4

Browse files
dfa1claude
andcommitted
docs(core): vortex.flat is a layout id, not an encoding id
The EncodingId javadoc examples used "vortex.flat", which lives in the footer's layoutSpecs table (Layout.FLAT), never in arraySpecs; the canonical flat encoding id is "vortex.primitive". Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1 parent 6f7952e commit 3c412b4

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

core/src/main/java/io/github/dfa1/vortex/core/model/EncodingId.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@
99

1010
/// Identity of an array encoding — either a spec [WellKnown] constant or a third-party [Custom] id.
1111
///
12-
/// The wire representation is always a string (e.g. `"vortex.flat"`); [#parse(String)] maps any
12+
/// The wire representation is always a string (e.g. `"vortex.primitive"`); [#parse(String)] maps any
1313
/// such string to a typed value, and [#id()] recovers the wire string from a typed value.
1414
///
1515
/// Extends [Serializable] so a [Custom] or [WellKnown] carried on a
1616
/// [io.github.dfa1.vortex.core.error.VortexException] survives serialization, matching the prior
1717
/// enum's implicit serializability.
1818
public sealed interface EncodingId extends Serializable permits EncodingId.WellKnown, EncodingId.Custom {
1919

20-
/// Returns the wire string of this encoding id (e.g. `"vortex.flat"`).
20+
/// Returns the wire string of this encoding id (e.g. `"vortex.primitive"`).
2121
///
2222
/// @return the wire string of this encoding id
2323
String id();

0 commit comments

Comments
 (0)