material-maker icon indicating copy to clipboard operation
material-maker copied to clipboard

Naming Consistency Tracker

Open Arnklit opened this issue 2 years ago • 3 comments

I've spotted a few naming inconsistencies various places in Material Maker. This bug is to track them and discuss them.

American vs British English:

Gray vs Grey American style English is generally used in software and in Material Maker. "Grey" and "Greyscale is used in several places, I suggest we change it to "Gray" and "Grayscale"

Node name: "Fill to Random Grey" -> "Fill to Random Gray" Node name: "Greyscale" -> "Grayscale" Node name: "Greyscale Uniform" -> "Grayscale Uniform" Node output name in node editor: "Greyscale" -> "Grayscale"

Note: We should also be sure to add aliases to for common British spellings such as "Colour" and "Grey"

Capitalization / Title Case

Most nodes have Title Case in their node and library names, but some do not, I think we should ensure they all do. Some of them have correct names on the node themselves, but not in the library

image

Library name: "Normal map" -> "Normal Map" Node name: "Swap channels" -> "Swap Channels" Node name: "Tones step" -> "Tones Step" Node name: "Tones map" -> "Tones Map"

Use of CamelCase in library

Some nodes use CamelCase in their names, I think we should get rid of these and use Title Case everywhere

Library name: "SwapChannels" -> "Swap Channels" Node and library name: "AdjustHSV" -> "Adjust HSV"

===================================================================

The above list is not complete, just a selection I spotted quickly. I'd be happy to do a PR for fixing all these consistency issues, but I'd like to hear if people feel there are any other things that should be taken into account.

Arnklit avatar Jun 08 '22 12:06 Arnklit

Great idea for 1.0.

RodZill4 avatar Jun 08 '22 18:06 RodZill4

Just noticed that the names in the Bricks node are inconsistent as well. "Running bond" -> "Running Bond" "HerringBone" -> "Herringbone" "Basket weave" -> "Basket Weave" "Spanish bond" -> "Spanish Bond"

Also comparing FBM Noise and Bricks, the way we name numbered variations is different.

In Bricks: Running bond, Running bond (2), Running bond (3)

In FBM: Cellular, Cellular2, Cellular3 ...

In Dirt: Dirt 1, Dirt 2, Dirt 3

I think we should definitely have a space between the name and the number, I'm not sure how I feel about the parenthesis around the number.

Arnklit avatar Jun 09 '22 08:06 Arnklit

No progress on this one. Too late for 1.0.

RodZill4 avatar Jul 12 '22 07:07 RodZill4