Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Resolve ensemble.calculateVolition[s] function name inconsistency #83

Open
mkremins opened this issue Nov 19, 2019 · 1 comment
Open

Comments

@mkremins
Copy link
Collaborator

mkremins commented Nov 19, 2019

Some of the examples and support materials throughout the repository refer to ensemble.calculateVolitions() (plural) instead of ensemble.calculateVolition() (singular). The singular name is the actual name of this function in the current version of Ensemble. Either we should update all our materials to refer to the current function name consistently, or we should change the name of this function to ensemble.calculateVolitions() and update all the other places we refer to this function with the new name.

Personally I'm in favor of the latter course of action. I think it's weird and confusing that this function name refers to "volition" (singular) when the thing it's actually doing is calculating and returning all of the volitions (plural). But either way, the inconsistency should be resolved.

@meldckn
Copy link
Collaborator

meldckn commented Nov 21, 2019

Agree!

Also rename loadSocialStructure() to match other analogous functions and differentiate better from less related functions (loadFile()):

loadSocialStructure() -> addSchema()?
addActions()
addCharacters()
addHistory()
addRules()

(There are probably other sets of related functions with inconsistent names.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants