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

Vague documentation of API #309

Open
droodman opened this issue May 19, 2024 · 0 comments
Open

Vague documentation of API #309

droodman opened this issue May 19, 2024 · 0 comments

Comments

@droodman
Copy link

At https://juliastats.org/StatsModels.jl/stable/api/#StatsAPI.coefnames, I read:

[StatsAPI.coefnames](https://juliastats.org/StatsModels.jl/stable/api/#StatsAPI.coefnames)
—
Function
coefnames(model::StatisticalModel)

Return the names of the coefficients.

I have just learned through trial and error and debugging that the RegressionTables.jl package expects the return values to be strings, not symbols. It seems to me that the API should precisely specify the types that coefnames() and similar functions can return.

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

1 participant