-
Notifications
You must be signed in to change notification settings - Fork 51
More consistent property naming #407
Copy link
Copy link
Open
Labels
analysisAdds or changes evolution analysis tools, e.g., `WolframModelEvolutionObject` propertiesAdds or changes evolution analysis tools, e.g., `WolframModelEvolutionObject` propertiesfeatureNew functionality, or change in existing functionalityNew functionality, or change in existing functionalitywolfram languageRequires Wolfram Language implementationRequires Wolfram Language implementation
Milestone
Metadata
Metadata
Assignees
Labels
analysisAdds or changes evolution analysis tools, e.g., `WolframModelEvolutionObject` propertiesAdds or changes evolution analysis tools, e.g., `WolframModelEvolutionObject` propertiesfeatureNew functionality, or change in existing functionalityNew functionality, or change in existing functionalitywolfram languageRequires Wolfram Language implementationRequires Wolfram Language implementation
The problem
Property names as they are right now are very confusing. I for one cannot remember them at all, and it takes me minutes to figure out what the correct property is for something. The entire naming convention needs to be rethought, and we should come up with names that are intuitive, and easy to deduce. This is related to #376.
Issues that need to be fixed (the suggestions below are not final and need to be thought through much more carefully):
"AllEvents...","...List", etc. We should keep the property names short, simple, and, if possible, memorable."...Contents"in its name."Expressions...", which should just take arguments which would specify whether a generation, an event, or a manual foliation is requested (State after manually chosen set of events #375). It will then encompass"AllExpressions","FinalState","StateAfterEvent", etc."VertexEdges(Hyperg|G)raph". So, for example, instead of"State", it should be"AtomsExpressionsHypergraph". Instead of"CausalGraph", it should be"EventsCausalGraph". Instead of"ExpressionsEventsGraph", it should be"ExpressionsEventsCausalGraph", etc.$WolframModelPropertiesand"Properties"property should immediately stop returning deprecated old property names.