Naming: Difference between revisions
From
No edit summary |
No edit summary |
||
| Line 3: | Line 3: | ||
* 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. | ||
* 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 wiki page name, etc. | ||
* 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]). | * 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]). | ||
* Adjectives: opinion size age shape color origin material purpose '''noun'''. | * Adjectives: opinion size age shape color origin material purpose '''noun'''. | ||
Revision as of 06:05, 30 July 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 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 OpenSCAD and OpenJSCAD function identifier, a wiki page name, etc.
- 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.
