frequenz-floss / frequenz-api-common

Shared protobuf definitions and Python bindings for Frequenz APIs
https://frequenz-floss.github.io/frequenz-api-common/
MIT License
1 stars 11 forks source link

Un-abbreviate `THD` in the `Metric` enum #177

Closed tiyash-basu-frequenz closed 6 months ago

tiyash-basu-frequenz commented 8 months ago

What's needed?

THD (Total Harmonic Distortion) is present as an abbreviation in the Metric enum here:

https://github.com/frequenz-floss/frequenz-api-common/blob/7997835d103221125258632173cab6de8fd697cd/proto/frequenz/api/common/v1/metrics/metric_sample.proto#L128-L132

There are t wo possible approaches here:

  1. We decided early on that we want to limit the use of abbreviations as much as possible. From that principle, we should replace THD with TOTAL_HARMONIC_DISTORTION.

  2. We do use some popular abbreviations, such as AC and DC. If we consider THD as a popular abbreviation, then we should leave it as is.

Here are a few words of wisdom from ChatGPT Abbreviating "Total Harmonic Distortion" as "THD" is quite common and generally considered a good idea, especially in professional and technical contexts where the term is well understood. Here are a few reasons why abbreviating it is beneficial: 1. **Industry Standard**: THD is a standard abbreviation in the fields of electrical engineering and power systems. Professionals in these fields are familiar with the term, so using the abbreviation can facilitate clearer and more efficient communication. 2. **Conciseness**: Using "THD" makes communication more concise, especially in technical documentation, reports, or discussions where the term may be used frequently. 3. **Clarity**: In technical writing and discussion, using well-known abbreviations can actually enhance clarity by avoiding the repetition of lengthy terms. However, it's important to consider the audience. If you're communicating with an audience that might not be familiar with the term (like non-technical staff, clients outside the engineering field, or in educational materials for beginners), it's a good practice to use the full term "Total Harmonic Distortion" at least once before switching to the abbreviation "THD." This approach ensures understanding and avoids confusion. Given your background in a technical field, using "THD" in your professional environment is likely appropriate and understood.

Proposed solution

No response

Use cases

No response

Alternatives and workarounds

No response

Additional context

No response