Skip to content

Commit

Permalink
simplified implementation documentation requirements
Browse files Browse the repository at this point in the history
  • Loading branch information
nevrome committed Feb 21, 2023
1 parent 3a04966 commit d062a9f
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ YYYY-SURNAME-001 (module root)
| implementations | 0 | | List of implementations in different programming languages | | | true |
| language | 1 | implementations | Programming language | String | Options: 'C#', 'Java', 'Julia', 'NetLogo', 'Processing', 'Python', 'R', 'Ruby'. | true |
| softwareDependencies | 1 | implementations | Listing any software (libraries, packages, etc), specifying the release version, on which the module implementation relies to properly function. | Array | free text | true |
| docsDir | 0 | | Relative path to the directory containing the general documentation resources. The same directory name should be also use inside implementations directories to contain implementation-specific documentation resources (see 'Module file structure' | String | path | false |
| docsDir | 0 | | Relative path to the directory containing general module documentation. | String | path | false |
| inputs | 0 | | List of inputs required by the module. Create entries for each of the variables that can or should be given/set externally, so that the module can work. | | | false |
| name | 1 | inputs | Parameter/variable/file name in the module. | String | free text | false |
| type | 1 | inputs | Parameter/variable/file type. Use the programming language specific type. | String | free text | false |
Expand Down
2 changes: 1 addition & 1 deletion nassa-schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@
"field": "docsDir",
"level": 0,
"parent": "",
"description": "Relative path to the directory containing the general documentation resources. The same directory name should be also use inside implementations directories to contain implementation-specific documentation resources (see 'Module file structure'",
"description": "Relative path to the directory containing general module documentation.",
"type": "String",
"format": "path",
"mandatory": false
Expand Down

0 comments on commit d062a9f

Please sign in to comment.