Add documentation to ExperimentDescriptionAPI #3679
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rhyolight
requested changes
Jun 7, 2017
There was a problem hiding this comment.
As-is, the RST renders pretty nasty. Please merge scottpurdy#8
RST formatting on exp-description-api
|
@rhyolight - merged your suggestions. What about the references to other source files? Is there a way to make those links? |
|
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` |
rhyolight
approved these changes
Jun 7, 2017
rhyolight
reviewed
Jun 7, 2017
| in the experiment files that are passed to it. | ||
| The :mod:`~nupic.frameworks.opf.experiment_runner` takes an instance of | ||
| this class as the description of the experiment to run. Similarly, | ||
| `scripts/run_opf_experiment.py` looks for an instance of this class in a |
There was a problem hiding this comment.
you can use double ticks to code-format something:
this is not code ``but this is``.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@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