Project

General

Profile

Feature #299

ConfigurationDefaults -> wiki format

Added by Tunnell, Christopher over 10 years ago. Updated about 9 years ago.

Status:
Rejected
Priority:
Low
Assignee:
Category:
common_py
Target version:
Start date:
28 January 2011
Due date:
% Done:

0%

Estimated time:
Workflow:

Description

this would be useful to convert this into something more browsable online. Some static based webpage maybe (with wiki option) that had:

variable name, default, type, comment

and an associated test that says if all variables are documented.


Related issues

Related to MAUS - Feature #179: docbooks?ClosedRogers, Chris06 November 2010

Actions
#1

Updated by Tunnell, Christopher over 10 years ago

  • Assignee deleted (Tunnell, Christopher)

Configuration defualst would then probably need to be turned into, for example, a dictionary:

map_reduce_type = {"default": "native_python", "unit":"string", "comment":"this can either be native_python or something else blah blah"}

something_energy_scale = {"default": 4, "units": "MeV/ADC count", "comment": "energy scale for something"}

#2

Updated by Tunnell, Christopher over 10 years ago

  • Target version changed from MAUS-v0.0.1 to Future MAUS release
#3

Updated by Rogers, Chris over 10 years ago

  • Assignee set to Rogers, Chris

I would like to make a json schema for the configuration. Then we need a schema parser that autogenerates documentation (from comments in the schema). Use the same parser for the json spill data parser.

#4

Updated by Rogers, Chris about 10 years ago

  • Target version changed from Future MAUS release to MAUS-v0.1.0
#5

Updated by Rogers, Chris almost 10 years ago

  • Target version changed from MAUS-v0.1.0 to Future MAUS release
#6

Updated by Rogers, Chris about 9 years ago

  • Status changed from Open to Rejected

Also available in: Atom PDF