Skip to content

Commit ca8b99a

Browse files
author
Frankie Robertson
committed
Add some docs to MemoryNextItemRule
1 parent 42f4f34 commit ca8b99a

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

src/next_item_rules/strategies/sequential.jl

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,9 @@ function show(io::IO, ::MIME"text/plain", rule::FixedRuleSequencer)
4141
end
4242

4343
"""
44+
$(TYPEDEF)
45+
$(TYPEDFIELDS)
46+
4447
"""
4548
@kwdef struct MemoryNextItemRule{MemoryT} <: NextItemRule
4649
item_idxs::MemoryT
@@ -51,6 +54,7 @@ function best_item(rule::MemoryNextItemRule, responses::TrackedResponses, _items
5154
# XXX: A few problems with this:
5255
# 1. Could run out of `item_idxs`
5356
# 2. Could return an item not in `items`
57+
# 3: Will not work if this is sequenced after items have already been administered
5458
# TODO: Add some basic error checking -- can only panic
5559
end
5660

0 commit comments

Comments
 (0)