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

Potential naming conflict #325

Closed
sbfnk opened this issue May 29, 2024 · 5 comments
Closed

Potential naming conflict #325

sbfnk opened this issue May 29, 2024 · 5 comments
Milestone

Comments

@sbfnk
Copy link
Contributor

sbfnk commented May 29, 2024

Just flaggin that the epidist class vs. epidist package might cause confusion in the future
https://github.com/epinowcast/epidist

@joshwlambert
Copy link
Member

Thanks for flagging, I had noticed this but didn't feel like it was likely to cause many issues. It does emphasise the notation and clarity of discussing packages, functions, and classes.

At the moment, my preference is not to change anything. If we decided the class name should change then <epiparameter> could be a suitable name as many classes are named after the package that exports them (e.g. <incidence>, <epicontacts>).

@joshwlambert
Copy link
Member

Tagging @jamesmbaazam as he mentioned the same thing recently.

@jamesmbaazam
Copy link
Member

Yes, I was wondering if it would be worth discussing and fixing sooner rather than later. <epidistribution> or <epiparameter> are good candidates.

@joshwlambert
Copy link
Member

I don't think anything needs fixing, as it assumes something is broken. There is no technical conflict (e.g. namespace conflict) as the {epidist} package doesn't contain an epidist() function (https://epidist.epinowcast.org/reference/index.html).

Although changing the class names in {epiparameter} could be done quickly we don't want to break scripts using the package. Hence, why I've been hesitant to make this change straight away.

I think the best next steps are to contact the maintainer(s) of {epidist} and discuss what would be best for both packages. What do you both think?

@joshwlambert
Copy link
Member

The epidist class will be renamed epiparameter in v0.3.0.

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

No branches or pull requests

3 participants