Docs wishlist

[brenthuisman]

This Issue keeps track of open but identified TODOs for the documentation. A docs wishlist! Please keep issue current (edit this text) so we keep track of things we know need to be corrected but are too small for a separate issue and/or cannot be handled right now.

• Cell Mechanism concepts page: include listing of default mechanisms, their name/tag and description, enumeration of parameters and their role/meaning/explanation wherever not absolutely trivial.
  • e.g. gnabar == maximum possible sodium conductance
• A concepts page that describes probes and samplers. (See Documentation for spikes and events #474)
• C++ API documentation for recipe is out of date Fix recipe docs for probes #1080
• remove em from custom css, and change all terms to :term:terms
• C++ API for mechanism_catalogue
• C++ API for morphology
• C++ API for segment_tree
• C++ API for regions and locsets
• C++ cable_cell page split and reorganize
• C++ event_generator docs
• Python event_generator docs
• Python API for cable_cell
• Python API for morphology
• Python API for gap_junctions (incomplete)
• Python API for iclamp
• Python API for spike_detector
• Python API for initial_ion_data
• Python API for cable_global_properties
• Concepts/cable_cell/decorations/place: fill the gaps
• Contribution: finish docs howto
• Contribution: add example howto?
• Contribution: add test howto
• Developer docs, Arbor internals.

Out of scope for this issue

• New tutorials, moved here: Documentation: tutorial structure, howtos #1369
• Use docstrings on user facing API: makes them guaranteed up-to-date, testable. Use docstrings on user facing API #1259, How is a compartment defined in arbor.cell_kind.cable? #1240

Edits

• @thorstenhater add event_generator

[thorstenhater]

Hi @brenthuisman ,

could you update the progress here?

[brenthuisman]

Updated.