doc: Mnemonics for cdict and sdict #704
Merged
+12
−8
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
IMHO,
cdict
andsdict
are not such great names. 🥴 It is not obvious what they mean. In the beginning, I thoughtcdict
meant “current dict” andsdict
meant “should (be) dict”, which is the wrong way around. I heard from other people that they mix up the dicts very often.So, apparently
cdict
stands for “config dict”, so it’s a dict describing the configuration in your repo. Whereassdict
stands for … what does it stand for? 🥴 If thought it was “statedict”, but the docs start with:So, both
cdict
andsdict
are “statedicts”? What’ssdict
then?I still went with “_s_dict stands for state dict”, because this makes sense in the context of the sentence.
(If I were to choose new names, I’d go with
state_on_node
instead ofsdict
andstate_as_configured
instead ofcdict
.)