v6 Wishlist

[angularsen]

This issue serves as a place to discuss what to include in this version, since major version bumps allow us to make breaking changes we think are necessary or worth it.

The wishlist keeps track of the items to include, but items may be added or removed at any time.

As changes are completed, they are added to https://github.com/angularsen/UnitsNet/wiki/Upgrading-from-5.x-to-6.x

Wishlist

• Remove BtuPerSquareFootDegreeFahrenheit Remove obsolete units #1372
• Fix plural form of Speed.MeterPerMinute
• Rename/fix calorie/btu units to specify their definition as International Steam Table (IT) or Thermochemical (th), see https://github.com/angularsen/UnitsNet/pull/1196/files#r1105112205
• Consistent imperial/UK/US unit namings v6 Wishlist #1200 (comment)
• UnitAbbreviationsCache.ctor() should create empty cache, not load default abbreviations 💥Change UnitAbbreviationsCache ctor to not load defaults #1476
• UnitParser.ctor(UnitAbbreviationsCache) should not fallback to built-in units if given null 💥Change UnitParser ctor to require unit abbreviations cache #1477
• Rename AbsorbedDoseOfIonizingRadiation to RadiationAbsorbedDose Add radiation equivalent dose #1352 (comment)
• Review all [Obsolete] in code and add to this list
  • Remove obsolete Equals overloads 🐛ComparisonType ignored in obsolete Equals method #1396 (comment)
  • Remove static Default getters pointing to UnitsNetSetup.Default 🔥Remove static Default getters, obsoleted by UnitsNetSetup #1475 reverted by Revert "🔥Remove static Default getters, obsoleted by UnitsNetSetup" #1480
• Fix typo in TonneSquareMilimeter, missing l
• Fix typo in VolumeConcentration.LitersPerMililiter, missing l VolumeConcentration: fix typo in LitersPerMililiter (missing 'l') #1497
• Remove TorquePerLength: dimensionless, domain specific, conflicts with Force = Torque / Length Removing TorquePerLength #1458
• Rename ThermalResistance to ThermalInsulance: enables future conversions between thermal conductivity, resistivity if added Rename ThermalResistance to ThermalInsulance #1460
• Change Angle base unit from Degree to Radian
• Fix typo KiloNewton => Kilonewton in SpecificFuelConsumption.json
• UnitParser: fix the nullability of the Parse / TryParse overloads #1445
• v6-Electric #1467
• 💥Remove obsolete electric quantities #1482
• Consolidate UnitsNetSetup.Default.UnitConverter and each quantity's DefaultConversionFunctions, these can become inconsistent when adding custom conversion functions at runtime. Consider making DefaultConversionFunctions internal, not public.

[maxreb]

Add System.Text.Json support #966

[angularsen]

Decide on a naming and abbreviation convention for imperial/UK units and US units; like gallon, ounces, cup etc.

It is a bit of a mess right now:

LINQPad sample

void ListUnits(string withPartialName)
{
    Quantity.Infos
        .SelectMany(i => i.UnitInfos
            .Where(n => n.Name.Contains(withPartialName))
            .Select(u => new 
            { 
                u.Name, 
                Abbrev = UnitAbbreviationsCache.Default.GetDefaultAbbreviation(u.Value.GetType(), Convert.ToInt32(u.Value)) 
            }))
        .Dump(withPartialName);
}

ListUnits("Uk");
ListUnits("Imperial");
ListUnits("Us");

I personally like "UK", since it is shorter and better matches "US".
Wolfram also uses US gallon and UK gallon.

Some conventions for imperial gallons:
https://en.wikipedia.org/wiki/Gallon#:~:text=the%20imperial%20gallon%20(imp%20gal,American%20and%20Caribbean%20countries%3B%20and

Today the abbreviation convention is gal (U.S.) and gal (imp.).
Depending on landing on UK or imperial naming, we could go with one of these pairs:

• US gal and UK gal
• US gal and imp gal
• gal (US) and gal (UK)

We can support multiple of these plus the old ones, but the primary form should be standardized across the different units.

[ebfortin]

Do not throw ArgumentException on NaN, Inf+ or Inf- or give a way to configure the behavior globally.

Context:
#1268 (comment)

[MisinformedDNA]

I think UnitsNet should be more extensible. Perhaps there could be a base package, but separate NuGet packages for US measurements, Imperial, UK, etc. Alternatively, customizable abbreviations could be a solution. I would never expect me or my users to see "gal (US)" instead of "gal". This would also help the debate here.

UPDATE:

Custom abbreviations already exist: UnitAbbreviationsCache.Default.MapUnitToDefaultAbbreviation(HowMuchUnit.Some, "sm");

[angularsen]

I think UnitsNet should be more extensible.

Conceptually, I agree.

Customizable abbreviations is already supported as you found, and we support custom quantities and units with some limited functionality: https://github.com/angularsen/UnitsNet/wiki/Extending-with-Custom-Units

Splitting up in packages is not so easy though. Things like Torque = Force * Length becomes problematic when types exist in different packages and they can't have circular dependencies. Imperial is even worse, splitting some units of a quantity to different packages. The main problem is static typing, which is also one of the main features of UnitsNet.

One benefit of splitting up in packages is smaller binary size to only bring in what you need.
Some prototyping here: #1181

[Markussp256]

I was requested to give a list of units with the wrong plural form (see #1330 )

I checked the .json-file with the speed units and only MetersPerMinute has a wrong plural form, all other Speed units seem to have the correct plural form.