search

numenta / nupic-legacy

Numenta Platform for Intelligent Computing is an implementation of Hierarchical Temporal Memory (HTM), a theory of intelligence based strictly on the neuroscience of the neocortex.
http://numenta.org/
GNU Affero General Public License v3.0
6.34k stars 1.56k forks source link

Add documentation to ExperimentDescriptionAPI #3679

Closed scottpurdy closed 7 years ago

scottpurdy commented 7 years ago

@rhyolight please advise on how to properly link to other source files and how to properly format the parameters and their lists of keys.

fixes #3678 fixes NUP-2430

scottpurdy commented 7 years ago

@rhyolight - merged your suggestions. What about the references to other source files? Is there a way to make those links?

rhyolight commented 7 years ago

Yes, it is typically:

:class:`full.namespace.ClassName`
:mod:`full.namespace`
:meth:`full.namespace.ClassName.methodName`

If you don't want the full namespace to each thing displayed, use ~:

:class:`~full.namespace.ClassName`
:mod:`~full.namespace`
:meth:`~full.namespace.ClassName.methodName`