Skip to content

Commit dbbe03c

Browse files
committed
docs: clarify episode number contract
1 parent 243e4e4 commit dbbe03c

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

include/aniparse/anime/AnimeModel.hpp

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -208,8 +208,10 @@ struct AnimeEpisodeInfo {
208208
/// Numeric hint for grouping/ordering in UI; not the episode's identity.
209209
/// Whole part only, 0 = unnumbered (a special), so not a usable sort key alone.
210210
long episode = 0;
211-
/// Episode number exactly as the source spells it: "7.5", "Special".
212-
/// Empty = render from @ref episode.
211+
/// Source episode number without a generic presentation label: "7.5", "10",
212+
/// or a non-numeric special marker such as "OVA". Do not include words such
213+
/// as "episode", "series", or their localized equivalents: those belong to
214+
/// the consuming UI. Empty = render from @ref episode.
213215
std::string number;
214216
/// Opaque episode handle, understood only by the getter that produced this
215217
/// info; round-trips into episode_sources() via ref().

0 commit comments

Comments
 (0)