Skip to content

Inconsistent casing in Lines and LineCodes for rmatrix, xmatrix and cmatrix #40

Open
@kdheepak

Description

@kdheepak

Currently the ODD interface exposes the following functions:

Lines.RMatrix
LineCodes.Rmatrix

Lines.XMatrix
LineCodes.Xmatrix

Lines.CMatrix
LineCodes.Cmatrix

It would be nice if these are consistent. @tshort, @PMeira any preferences?

The C API uses Lines_Get_Rmatrix, LineCodes_Get_Rmatrix, etc. So my vote is to use the same casing, i.e. change the functions in the Lines module. I believe the COM interface in the official distribution also uses this casing here.

The main reason I'm opening an issue for this is that this is technically an API breaking change, so it would require a major version update. But given that v0.5.0 hasn't been updated on the METADATA.jl yet, it might be safe to assume no one is using the tagged v0.5.0 version yet and maybe we can get away with the change in v0.5.1. Thoughts?

Alternatively, we can go with deprecation warnings and remove the other functions in the next major release.

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