WillB97 / srcomp-pystream

SRComp HTTP EventStream and WebSocket module
MIT License
0 stars 1 forks source link

Several things called "state" #6

Open PeterJCLaw opened 1 year ago

PeterJCLaw commented 1 year ago

This implementation unfortunately has several things which are all called "state" in one way or another. It would be great if the names could be clarified, perhaps just by dropping "state" where it's not needed and maybe just sticking to the names of the underlying endpoints. An obvious case of this is where the cached value of the /current endpoint is handled in a method called update_current_state.

In SRComp a "state" is most commonly a "compstate" or a revision thereof, so limiting usage to things which represent that might help clarify this codebase.