Proof read Sphinx help docs (Trac #356)

[smk78]

The new Sphinx help docs need proof reading for content, style, accuracy, compatibility with new/deprecated functionality, typos, grammar, etc.

Migrated from http://trac.sasview.org/ticket/356

{
    "status": "closed",
    "changetime": "2015-06-04T15:47:51",
    "_ts": "2015-06-04 15:47:51.657633+00:00",
    "description": "The new Sphinx help docs need proof reading for content, style, accuracy, compatibility with new/deprecated functionality, typos, grammar, etc.",
    "reporter": "smk78",
    "cc": "",
    "resolution": "fixed",
    "workpackage": "SasView Documentation",
    "time": "2015-02-18T22:26:48",
    "component": "SasView",
    "summary": "Proof read Sphinx help docs",
    "priority": "major",
    "keywords": "",
    "milestone": "SasView 3.1.0",
    "owner": "smk78",
    "type": "enhancement"
}

[smk78]

Trac update at 2015/02/18 22:28:10: smk78 commented:

All now parsed at 'Level 0', meaning they build in Sphinx.

[smk78]

Trac update at 2015/02/18 22:30:52: smk78 commented:

Current status of proof reading is indicated by the presence/absence of a Sphinx note in each document (usually at the bottom)

[smk78]

Trac update at 2015/02/18 22:41:15: smk78 commented:

Proof read so far:

data_explorer_help.rst
data_formats.rst
graph_help.rst
data_operator_help.rst
density_calculator_help.rst
image_viewer_help.rst
kiessig_calculator_help.rst

To do:

model_functions.rst !!! (should be done model-by-model as new model structure implemented)

fitting_help.rst
invariant_help.rst
pr_help.rst
python_shell_help.rst
resolution_calculator_help.rst
sas_calculator_help.rst
sld_calculator_help.rst
slit_calculator_help.rst

[smk78]

Trac update at 2015/02/19 14:43:24: smk78 commented:

Proof read so far:

data_explorer_help.rst
data_formats.rst
graph_help.rst
data_operator_help.rst
density_calculator_help.rst
image_viewer_help.rst
kiessig_calculator_help.rst
python_shell_help.rst
resolution_calculator_help.rst
sas_calculator_help.rst
sld_calculator_help.rst

To do:

model_functions.rst !!! (should be done model-by-model as new model structure implemented)

fitting_help.rst
invariant_help.rst
pr_help.rst
slit_calculator_help.rst

[smk78]

Trac update at 2015/02/19 21:53:34: smk78 commented:

Proof read so far:

data_explorer_help.rst
data_formats.rst
graph_help.rst
data_operator_help.rst
density_calculator_help.rst
image_viewer_help.rst
invariant_help.rst
kiessig_calculator_help.rst
pr_help.rst
python_shell_help.rst
resolution_calculator_help.rst
sas_calculator_help.rst
sld_calculator_help.rst
slit_calculator_help.rst

To do:

model_functions.rst !!! (should be done model-by-model as new model structure implemented)

fitting_help.rst

[sasview-bot]

Trac update at 2015/03/18 21:15:02: krzywon commented:

I took a look at fitting_help.rst but the sections "Single Fit" and "Simultaneous Fit" talk about choosing fitting engines (Scipy vs. Park). With the conversion to bumps, this is now all obsolete and needs a complete rewrite.

[smk78]

Trac update at 2015/03/19 11:13:56: smk78 commented:

Noted.

I only just got to start 'proof-reading' this file at Code Camp so it is at present largely untouched.

Leave it with me!