Naming question: BlendPercentage isn't really a percentage?

[atruskie]

I have noticed that GraphicsOptions.BlendPercentage is not really a percentage (a number in the range [0,100]) .

ImageSharp/src/ImageSharp/GraphicsOptions.cs

Lines 56 to 72 in 78a584e

	/// <summary>
	/// Gets or sets a value between indicating the blending percentage to apply to the drawing operation.
	/// Range 0..1; Defaults to 1.
	/// </summary>
	public float BlendPercentage
	{
	get
	{
	return this.blendPercentage;
	}
	set
	{
	Guard.MustBeBetweenOrEqualTo(value, 0, 1F, nameof(this.BlendPercentage));
	this.blendPercentage = value;
	}
	}

This is quite a nit-picky ask: but is it worth changing the name?

I wouldn't bring it up except that I keep having to refer to the XML document to understand the range of acceptable values. There is a small cognitive overload each time when I realize the implied range [0,100] is not equal to the actual range [0.0, 1.0].

Alternate names:

• BlendRatio
• BlendFraction
• BlendQuotient (most correct, too technical?)
• BlendAmount (no context, no implied range)

[antonfirsov]

Good point! I also dislike this name just didn't care about it too much, would vote for BlendRatio ... if we could still change it.

Unfortunately, as we promised API stability with our 1.0 release of the main library, and I have a very strong opinion that we should keep our promises, and keep breaking changes at an absolute minimum, so I'm afraid there is no way back :(

Note that similar suggestions are more than welcome in Drawing, since it's still in beta.

[JimBobSquarePants]

Yeah. Not much we can do about that now.

[JimBobSquarePants]

I wonder...

If we added a better named property that the old property will proxy to, marked the old property as Obsolete and used EditorBrowsable to also hide the old property from intellisense would that work?

[atruskie]

💯

I had the same idea but didn't know about EditorBrowsable and thought the intellisense noise would be too much

[antonfirsov]

This is a good idea! Note that BCL is already doing similar change (even without using [ObsoleteAttribute] .. yet):

dotnet/runtime#43901

[antonfirsov]

related: #1454