Skip to content

Latest commit

 

History

History
76 lines (46 loc) · 1.3 KB

GUIDELINES.md

File metadata and controls

76 lines (46 loc) · 1.3 KB

Commands will follow the following naming conventions:

Terminology

Commands are comprised of the following components

  • noun = type of object to manipulate
  • nouns = identifies the type of id expected in printout
  • verb = manipulation to be preformed
  • verbed = identify that a manipulation was performed
  • adverbs = information nececary to manipulate
  • ids = one or more id of a noun
  • prop = property to display

Get Property

noun-get-prop ids

prints one line of information per id returns 1 on error otherwise 0

Setting information

noun-verb adverbs ids

prints nothing returns 1 on error otherwise 0

List by Association

noun-get-noun ids

given ids are of the first noun type prints one associated id per line returns 1 on error otherwise 0

noun-get-nouns ids

given ids are of the first noun type prints one line for each id with ids of the second noun type returns 1 on error otherwise 0

List by Status

noun-list-verbed

prints ids of the nouns affected returns 1 on error otherwise 0

List by Association

noun-list-by-noun

prints ids of the nouns associated returns 1 on error otherwise 0

Testing Status

noun-is-verbed ids

prints nothing returns 1 or 0 depending on check