Skip to content

Vague documentation of API #309

Description

@droodman

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.

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions