dss-extensions / dss-extensions/dss-extensions

API: Naming consistency

Open
#5 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
TeX
Stars
9
Forks
0
PR merge metrics
No merged PRs in 30d

Description

Besides parameter type inconsistency such as the bool vs int issue (hopefully fixed now), there are some inconsistencies in names, including casing ported from the official OpenDSS (COM) API. I imagine that's due to both Pascal and VB being case insensitive. For Python, `win32com` is also case insensitive with late bindings usage. Our DSS_MATLAB implementation is mostly case-insensitive too (it uses the [SetGet mixin](https://www.mathworks.com/help/matlab/ref/matlab.mixin.setget-class.html)).

By version 1.0, we should address this. My opinion nowadays is that we should fix the inconsistencies and the downstream projects can handle the compatibility with the COM names. DSS Python/MATLAB/Sharp should keep the COM names by default, the other projects are free to choose.

See also: https://github.com/dss-extensions/OpenDSSDirect.jl/issues/40

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.