Merge pull request #2774 from jessica-mitchell/add-technical-docs

Update branch to be up-to-date with master

.cppcheck_suppressions

@@ -0,0 +1,37 @@
+invalidPrintfArgType_sint:./
+invalidscanf:./
+unknownMacro:./testsuite/cpptests/test_target_fields.h
+useStlAlgorithm:./
+variableScope:./
+shadowVariable:./
+shadowFunction:./
+constParameter:./
+postfixOperator:./
+passedByValue:./
+virtualCallInConstructor:./
+uninitMemberVar:./
+noExplicitConstructor:./
+missingOverride:./
+identicalConditionAfterEarlyExit:./
+unreadVariable:./
+clarifyCondition:./
+toomanyconfigs:./
+unusedPrivateFunction:./
+unusedVariable:./
+shadowArgument:./
+useInitializationList:./
+noConstructor:./
+stlcstrReturn:./
+ConfigurationNotChecked:./
+unusedStructMember:./
+unpreciseMathCall:./
+operatorEqVarError:./
+duplicateExpression:./
+// integerOverflow:./
+ignoredReturnValue:./
+unusedFunction:./
+duplicateCondition:./
+nullPointer:./
+missingInclude:./
+uninitvar:./
+

.github/styles/Vocab/nest-vocab/accept.txt

@@ -0,0 +1,24 @@
+NEST
+GIDCollection
+iaf
+aeif
+psc
+cond
+Hodgkin
+Huxley
+clopath
+stdp
+stp
+mpi
+vp
+rng
+excitatory
+inhibitory
+HEP
+JME
+Plesser
+Eppler
+Hahne
+Senk
+Jordan
+Kunkel

.github/styles/nest-styles/Abbreviations.yml

@@ -0,0 +1,12 @@
+---
+extends: substitution
+message: Use '%s' instead of '%s'
+ignorecase: false
+level: error
+nonword: true
+swap:
+  '\beg\b': e.g.,
+  '\bie\b': i.e.,
+  'e\.g\.(?:[^,]|$)': e.g.,
+  'i\.e\.(?:[^,]|$)': i.e.,
+  '(?i)\d{1,2} ?[ap]m': a.m. or p.m.

.github/styles/nest-styles/Ampersands.yml

@@ -0,0 +1,8 @@
+---
+extends: existence
+message: "Don't use ampersands unless one is part of a company or brand name."
+level: warning
+nonword: true
+tokens:
+  - '\w+\s&\s\w+'
+

.github/styles/nest-styles/Annotations.yml

@@ -0,0 +1,11 @@
+---
+extends: existence
+message: "'%s' left in text."
+ignorecase: false
+level: error
+tokens:
+  - XXX
+  - FIXME
+  - TODO
+  - NOTE
+

.github/styles/nest-styles/Capitalization.yml

@@ -0,0 +1,7 @@
+---
+extends: capitalization
+message: "'%s' should be in sentence case"
+level: warning
+scope: heading
+match: $sentence
+

.github/styles/nest-styles/CommasPerSentence.yml

@@ -0,0 +1,7 @@
+---
+message: "More than 3 commas!"
+extends: occurrence
+scope: sentence
+max: 3
+token: ','
+

.github/styles/nest-styles/ComplexWords.yml

@@ -0,0 +1,121 @@
+---
+extends: substitution
+message: Consider using %s instead of '%s'
+ignorecase: true
+level: warning
+swap:
+  'approximate(?:ly)?': "'about'"
+  absent: "'none' or 'not here'"
+  abundance: "'plenty'"
+  accelerate: "'speed up'"
+  accentuate: "'stress'"
+  accompany: "'go with'"
+  accomplish: "'carry out' or 'do'"
+  accorded: "'given'"
+  accordingly: "'so'"
+  accrue: "'add'"
+  accurate: "'right' or 'exact'"
+  acquiesce: "'agree'"
+  acquire: "'get' or 'buy'"
+  additional: "'more' or 'extra'"
+  address: "'discuss'"
+  addressees: "'you'"
+  adjacent to: "'next to'"
+  adjustment: "'change'"
+  admissible: "'allowed'"
+  advantageous: "'helpful'"
+  advise: "'tell'"
+  aggregate: "'total'"
+  aircraft: "'plane'"
+  alleviate: "'ease'"
+  allocate: "'assign' or 'divide'"
+  alternatively: "'or'"
+  alternatives: "'choices' or 'options'"
+  ameliorate: "'improve'"
+  amend: "'change'"
+  anticipate: "'expect'"
+  apparent: "'clear' or 'plain'"
+  ascertain: "'discover' or 'find out'"
+  assistance: "'help'"
+  attain: "'meet'"
+  attempt: "'try'"
+  authorize: "'allow'"
+  belated: "'late'"
+  bestow: "'give'"
+  cease: "'stop' or 'end'"
+  collaborate: "'work together'"
+  commence: "'begin'"
+  compensate: "'pay'"
+  component: "'part'"
+  comprise: "'form' or 'include'"
+  concept: "'idea'"
+  concerning: "'about'"
+  confer: "'give' or 'award'"
+  consequently: "'so'"
+  consolidate: "'merge'"
+  constitutes: "'forms'"
+  contains: "'has'"
+  convene: "'meet'"
+  demonstrate: "'show' or 'prove'"
+  depart: "'leave'"
+  designate: "'choose'"
+  desire: "'want' or 'wish'"
+  determine: "'decide' or 'find'"
+  detrimental: "'bad' or 'harmful'"
+  disclose: "'share' or 'tell'"
+  discontinue: "'stop'"
+  disseminate: "'send' or 'give'"
+  eliminate: "'end'"
+  elucidate: "'explain'"
+  employ: "'use'"
+  enclosed: "inside or 'included'"
+  encounter: "'meet'"
+  endeavor: "'try'"
+  enumerate: "'count'"
+  equitable: "'fair'"
+  equivalent: "'equal'"
+  exclusively: "'only'"
+  expedite: "'hurry'"
+  facilitate: "'ease'"
+  females: "'women'"
+  finalize: "'complete' or 'finish'"
+  frequently: "'often'"
+  identical: "'same'"
+  incorrect: "'wrong'"
+  indication: "'sign'"
+  initiate: "'start' or 'begin'"
+  itemized: "'listed'"
+  jeopardize: "'risk'"
+  liaise: "'work with' or 'partner with'"
+  maintain: "'keep' or 'support'"
+  methodology: "'method'"
+  modify: "'change'"
+  monitor: "'check' or 'watch'"
+  multiple: "'many'"
+  necessitate: "'cause'"
+  notify: "'tell'"
+  numerous: "'many'"
+  objective: "'aim' or 'goal'"
+  obligate: "'bind' or 'compel'"
+  optimum: "'best' or 'most'"
+  permit: "'let'"
+  portion: "'part'"
+  possess: "'own'"
+  previous: "'earlier'"
+  previously: "'before'"
+  prioritize: "'rank'"
+  procure: "'buy'"
+  provide: "'give' or 'offer'"
+  purchase: "'buy'"
+  relocate: "'move'"
+  request: "'ask'"
+  solicit: "'request'"
+  state-of-the-art: "'latest'"
+  subsequent: "'later' or 'next'"
+  substantial: "'large'"
+  sufficient: "'enough'"
+  terminate: "'end'"
+  transmit: "'send'"
+  utilization: "'use'"
+  utilize: "'use'"
+

.github/styles/nest-styles/ListCapitalize.yml

@@ -0,0 +1,9 @@
+---
+extends: existence
+message: "Capitalize the first word in a list."
+level: warning
+scope: list
+nonword: true
+tokens:
+  - '^[a-z].+'
+

.github/styles/nest-styles/Negative.yml

@@ -0,0 +1,12 @@
+---
+extends: existence
+message: "Use positive language rather than negative language like “%s.”"
+link: http://styleguide.mailchimp.com/grammar-and-mechanics/#header-3-write-positively
+level: warning
+tokens:
+  - can't
+  - won't
+  - don't
+  - doesn't
+  - hasn't
+

.github/styles/nest-styles/NotEasy.yml

@@ -0,0 +1,11 @@
+---
+extends: existence
+message: Consider removing '%s'
+ignorecase: true
+level: warning
+tokens:
+  - simple
+  - just
+  - easily
+  - simply
+

.github/styles/nest-styles/OxfordComma.yml

@@ -0,0 +1,8 @@
+---
+extends: existence
+message: 'Use the Oxford comma in a list of three or more items.'
+link: 'https://contribute.jquery.org/style-guide/prose/#grammar'
+scope: sentence
+level: warning
+tokens:
+  - '(?:[^,]+,){1,}\s\w+\sand'

.github/styles/nest-styles/ParagraphLength.yml

@@ -0,0 +1,8 @@
+---
+message: "Paragraphs should be less than 150 words"
+extends: occurrence
+scope: paragraph.rst
+level: suggestion
+max: 150
+token: \b(\w+)\b
+