Naming: Difference between revisions

From
No edit summary
No edit summary
Line 1: Line 1:
Replimat is divided into [[:Category:Vitamins|vitamins]], [[:Category:Materials|materials]], [[:Category:Transformations|transformations]], [[:Category:Parts|parts]], [[:Category:Techniques|techniques]], [[:Category:Projects|projects]], and [[:Category:Lifecycles|lifecycles]].  Names for patterns in each of these categories follow conventions noted here:
Replimat is divided into [[:Category:Vitamins|vitamins]], [[:Category:Materials|materials]], [[:Category:Transformations|transformations]], [[:Category:Parts|parts]], [[:Category:Techniques|techniques]], [[:Category:Projects|projects]], and [[:Category:Lifecycles|lifecycles]].  Names for patterns in each of these categories follow conventions noted on this page.  Conventions are intended to function as guidelines to reduce effort.  Where necessary, they may be overridden at any level within the system, but doing so should serve as a hint toward improvement.


* A name should function as a label for a single pattern within it's category.
* A name should function as a label for a single pattern within it's category.

Revision as of 18:30, 29 June 2021

Replimat is divided into vitamins, materials, transformations, parts, techniques, projects, and lifecycles. Names for patterns in each of these categories follow conventions noted on this page. Conventions are intended to function as guidelines to reduce effort. Where necessary, they may be overridden at any level within the system, but doing so should serve as a hint toward improvement.

  • 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).
  • Adjectives: opinion size age shape color origin material purpose noun.

References