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

Rename ValueSupport subtypes to more specific names #1870

Closed
juliohm opened this issue Jun 14, 2024 · 1 comment
Closed

Rename ValueSupport subtypes to more specific names #1870

juliohm opened this issue Jun 14, 2024 · 1 comment

Comments

@juliohm
Copy link
Contributor

juliohm commented Jun 14, 2024

Currently the subtypes of ValueSupport are Discrete and Continuous as described here:

### ValueSupport
```@docs
Distributions.ValueSupport
```
The `ValueSupport` sub-types defined in `Distributions.jl` are:
```@docs
Distributions.Discrete
Distributions.Continuous
```
**Type** | **Default element type** | **Description** | **Examples**
--- | --- | --- | ---
`Discrete` | `Int` | Samples take countably many values | $\{0,1,2,3\}$, $\mathbb{N}$
`Continuous` | `Float64` | Samples take uncountably many values | $[0, 1]$, $\mathbb{R}$

These names are too generic to export, and conflict with other mathematical packages.

Would you be ok with renaming these two to DiscreteSupport and ContinuousSupport?

I can work on a PR that includes a deprecation warning.

@devmotion
Copy link
Member

Is there an actual problem/conflict with some other package? My initial feeling is that we should only make such a change if it's worth it.

@juliohm juliohm closed this as completed Jul 7, 2024
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

Successfully merging a pull request may close this issue.

2 participants