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

Shorten and standardise struct names #499

Open
seabbs opened this issue Oct 11, 2024 · 4 comments
Open

Shorten and standardise struct names #499

seabbs opened this issue Oct 11, 2024 · 4 comments
Labels
enhancement New feature or request

Comments

@seabbs
Copy link
Collaborator

seabbs commented Oct 11, 2024

As discussed in #496 many of the struct names are quite long and are not 100% consistent. We should enforce consistency and also aim for less verbose struct names.

I think an easy change is to go from

  • Observation -> Obs

Any other suggestions?

To minimise breaking changes I think we should do a single renaming PR so lets collect suggestions here.

@seabbs seabbs added the enhancement New feature or request label Oct 11, 2024
@SamuelBrand1
Copy link
Collaborator

Could we not do this with some alias names?

@SamuelBrand1
Copy link
Collaborator

e.g.

const NiceAlias = VerboseStructName

This is a cost free abstraction

@seabbs
Copy link
Collaborator Author

seabbs commented Oct 11, 2024

Yes we could and I agree that would be good for another issue (i.e add alieas for example making AutoRegressive exist and AR, RandomWalk and RW but the key issue we have here is making sure we have a standard and following it.

Thee big thing that stands out to me is the the module is called EpiObsModels and we have RecordExpectedObs but everything else uses Observations

@seabbs
Copy link
Collaborator Author

seabbs commented Oct 11, 2024

(could you make the alias issue :). )

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants