Naming: Difference between revisions

From
m (Tim moved page Naming conventions to Naming)
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 on this page.  Conventions are intended to function as guidelines to reduce effort required to choose an appropriate name.  Where necessary, they may be overridden at any level within the system, but doing so should serve as a hint toward improved organization.
Replimat names are 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 required to choose an appropriate name.  Where necessary, they may be overridden at any level within the system, but doing so should serve as a hint toward improved organization.


* 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 16:54, 23 October 2021

Replimat names are 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 required to choose an appropriate name. Where necessary, they may be overridden at any level within the system, but doing so should serve as a hint toward improved organization.

  • 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 NopSCADlib / OpenSCAD, OpenJSCAD, or Rust function identifier, a wiki page name, etc.
  • A name should be plural, to enable project-wide object relational mapping efforts (more details here).
  • Adjective structure should follow the pattern: opinion size age shape color origin material purpose noun.

References