Open JacobVanGeffen opened 1 month ago
Agreed!
I think that some of the _ip
postfix vs no postfix isn't quite so straightforward. For instance PostFlopNode::num_elements
is always the number of 'elements' the current player has, while PostFlopNode::num_elements_ip
is the number of elements IP has, but only on the first node of a street.
It would be good to:
We should put this into the docs
branch as that is where I'm keeping track of all new documentation and clarity renaming changes.
Now part of PR #4
Inappropriately named functions/variables should be changed to follow these rules:
check
should not update state).ip
when a variable only describes in-position data).For example,
check_card_config
should be renamed to reflect the fact that it updates state throughinit_hands
.Additionally, there is currently a convention of state variables having either no postfix to mean "applies to out-of-position" and postfix
_ip
to mean "applies to in-position". Variables representing out-of-position traits should be postfixed with_oop
to make this distinction clear.