Inconsistent use of terms "Border" and "Region" #97286

New Issue

ChameleonScales · 2022-04-12T19:41:39+02:00

ChameleonScales commented

2022-04-12 19:41:39 +02:00

Blender Version: 3.1.2

Short description of error
To my knowledge, the term Render Border is (or will be) deprecated. It used to be what is now called Render Region and had the same meaning. Some operators still use that term though.

Exact steps for others to reproduce the error

in Preferences > Interface, enable "Developer Extras"
in 3DView, hit F3 and type "border". There are 5 results:
- "Zoom to Border": This one is unrelated, as it doesn't refer to Render Regions. Could still use the term Region anyway, though border is fine to me here.
- "Reset Render Border": should definitely use the term Region
- "Clipping Region": unrelated to Render Region, but python operator label uses "border" while the UI name uses "Region" (API backwards compatibility reasons?)
- "Set Render Region": same here, python label uses "border", UI name uses "Region".

Keeping the legacy term in the API label makes sense (prevents add-ons from breaking), though eventually it should be consistent with the UI. At the very least the UI names should be consistent.

Note: Changing to "Region" was a great decision imo, as its meaning is much more explicit than Border.

Blender Version: 3.1.2 **Short description of error** To my knowledge, the term Render Border is (or will be) deprecated. It used to be what is now called Render Region and had the same meaning. Some operators still use that term though. **Exact steps for others to reproduce the error** - in Preferences > Interface, enable "Developer Extras" - in 3DView, hit F3 and type "border". There are 5 results: - "Zoom to Border": This one is unrelated, as it doesn't refer to Render Regions. Could still use the term Region anyway, though border is fine to me here. - "Reset Render Border": should definitely use the term Region - "Clipping Region": unrelated to Render Region, but python operator label uses "border" while the UI name uses "Region" (API backwards compatibility reasons?) - "Set Render Region": same here, python label uses "border", UI name uses "Region". Keeping the legacy term in the API label makes sense (prevents add-ons from breaking), though eventually it should be consistent with the UI. At the very least the UI names should be consistent. Note: Changing to "Region" was a great decision imo, as its meaning is much more explicit than Border.

ChameleonScales commented

2022-04-12 19:41:39 +02:00

Added subscriber: @ChameleonScales

Pratik Borhade commented

2022-04-13 07:41:16 +02:00

Added subscriber: @PratikPB2123

Pratik Borhade commented

2022-04-13 07:54:24 +02:00

Changed status from 'Needs Triage' to: 'Needs Developer To Reproduce'

Pratik Borhade commented

2022-04-13 07:54:24 +02:00

Hi, thanks for the report.

"Zoom to Border": This one is unrelated, as it doesn't refer to Render Regions. Could still use the term Region anyway, though border is fine to me here.

This option is already named as Zoom Region in View > navigation popover: https://docs.blender.org/manual/en/latest/editors/3dview/navigate/navigation.html#zoom-region

Keeping the legacy term in the API label makes sense (prevents add-ons from breaking), though eventually it should be consistent with the UI

I'll leave this for #python_api & UI developers to make the decision.

Hi, thanks for the report. > "Zoom to Border": This one is unrelated, as it doesn't refer to Render Regions. Could still use the term Region anyway, though border is fine to me here. This option is already named as `Zoom Region` in View > navigation popover: https://docs.blender.org/manual/en/latest/editors/3dview/navigate/navigation.html#zoom-region > Keeping the legacy term in the API label makes sense (prevents add-ons from breaking), though eventually it should be consistent with the UI I'll leave this for #python_api & UI developers to make the decision.

ChameleonScales commented

2022-04-13 09:50:47 +02:00

This option is already named as Zoom Region in View > navigation popover:

Indeed, in fact the same operator appears twice under the 2 different names if you F3 search for "zoom".

I just realized you need to have "Developers Extras" enabled for the F3 search to show the 5 results I was previously talking about, so I added it in the steps.

> This option is already named as Zoom Region in View > navigation popover: Indeed, in fact the same operator appears twice under the 2 different names if you F3 search for "zoom". I just realized you need to have "Developers Extras" enabled for the F3 search to show the 5 results I was previously talking about, so I added it in the steps.

William Reynish commented

2022-04-13 15:21:23 +02:00

Added subscriber: @WilliamReynish

William Reynish commented

2022-04-13 15:21:23 +02:00

If there is doubt about what is most correct, see the dictionary:

Border:
1: A line separating two countries, administrative divisions, or other areas.
2: The edge or boundary of something, or the part near it.

Region:
1: An area, especially part of a country or the world having definable characteristics but not always fixed boundaries
2: A part of the body, especially around or near an organ.

The term 'border' is definitely incorrect, since all the the 'border' operations in Blender never refer to the borders/edged of something. For example, 'render border' doesn't only render the borders/edges, it render whatever is inside the area/region defined by the user.

'Region' is more correct.

If there is doubt about what is most correct, see the dictionary: **Border:** 1: A line separating two countries, administrative divisions, or other areas. 2: The edge or boundary of something, or the part near it. **Region:** 1: An area, especially part of a country or the world having definable characteristics but not always fixed boundaries 2: A part of the body, especially around or near an organ. The term 'border' is definitely incorrect, since all the the 'border' operations in Blender never refer to the borders/edged of something. For example, 'render border' doesn't only render the borders/edges, it render whatever is inside the area/region defined by the user. 'Region' is more correct.

Thomas Dinges added this to the 2.90 milestone 2023-02-08 16:25:00 +01:00

Philipp Oeser removed the

Download

What's New

Blender Studio

Manual

Developers Blog

Documentation

Benchmark

Blender Conference

Development Fund

One-time Donations

Inconsistent use of terms "Border" and "Region" #97286