Naming: Difference between revisions

From
No edit summary
No edit summary
Line 4: Line 4:
* A name should be unique within it's category.
* A name should be unique within it's category.
* A name should function with minimal modification (for instance: replacing spaces with underscores) as an OpenSCAD and OpenJSCAD function identifier.
* A name should function with minimal modification (for instance: replacing spaces with underscores) as an OpenSCAD and OpenJSCAD function identifier.
* A name should be plural, to enable project-wide [https://en.wikipedia.org/wiki/Object%E2%80%93relational_mapping object relational mapping] efforts.
* A name should be plural, to enable project-wide [https://en.wikipedia.org/wiki/Object%E2%80%93relational_mapping object relational mapping] efforts (more details [https://flourishlib.com/docs/fORM.html here]).

Revision as of 20:30, 22 May 2021

Replimat is divided into vitamins, materials, transformations, parts, techniques, projects, and lifecycles. Names for patterns in each of these categories follow conventions noted here:

  • A name should function as a label for a single pattern within it's category.
  • A name should be unique within it's category.
  • A name should function with minimal modification (for instance: replacing spaces with underscores) as an OpenSCAD and OpenJSCAD function identifier.
  • A name should be plural, to enable project-wide object relational mapping efforts (more details here).