diff --git a/brain/neuron/morphology.h b/brain/neuron/morphology.h index 5d1dcb7..44d7ee8 100644 --- a/brain/neuron/morphology.h +++ b/brain/neuron/morphology.h @@ -133,7 +133,7 @@ class Morphology : public boost::noncopyable /** Return the object with the information about the neuron soma */ BRAIN_API Soma getSoma() const; - /** Return \if pybind a 4x4 numpry arry with \endif + /** Return \if pybind a 4x4 numpy array with \endif * the transformation that was passed to the constructor or the * identity matrix is no transformation was given. */ diff --git a/brain/neuron/section.h b/brain/neuron/section.h index b49fca0..831ee89 100644 --- a/brain/neuron/section.h +++ b/brain/neuron/section.h @@ -84,7 +84,7 @@ class Section * If this sections is a soma section return the list of points of the * soma profile poly-line. * - * @return A list of point positions with radius. For a section consisting + * @return A list of point positions with diameter. For a section consisting * of n segments, this list will have n + 1 points. */ BRAIN_API Vector4fs getSamples() const; diff --git a/doc/Changelog.md b/doc/Changelog.md index 1f5a8a7..6d1c59d 100644 --- a/doc/Changelog.md +++ b/doc/Changelog.md @@ -3,6 +3,9 @@ Changelog {#Changelog} # git master +* [141](https://github.com/BlueBrain/Brion/pull/141): + Fixed documentation to specify that morphology section samples report + diameters and not radii. * [136](https://github.com/BlueBrain/Brion/pull/136): Implement readable null:// compartment report for benchmarking * [130](https://github.com/BlueBrain/Brion/pull/130): diff --git a/doc/python/python tutorial.ipynb b/doc/python/python tutorial.ipynb index ac42c1e..a785bd8 100644 --- a/doc/python/python tutorial.ipynb +++ b/doc/python/python tutorial.ipynb @@ -18,7 +18,7 @@ "\n", "Before you start you have to make sure that you have the Python module available in your environemnt. In the Blue Brain clusters you have two possibilities depending on the Python version you want to use:\n", "* For Python 3.4: ```module load BBP/viz/latest```\n", - "* For Python 2.7: ```module load memcache/bbpviz nix/viz/brion/1.8 nix/python2.7-full```" + "* For Python 2.7: ```module load memcache/bbpviz nix/viz/brion/2.0 nix/python2.7-full```" ] }, { diff --git a/doc/python/python_tutorial.rst b/doc/python/python_tutorial.rst index 31e1c29..333fad2 100644 --- a/doc/python/python_tutorial.rst +++ b/doc/python/python_tutorial.rst @@ -26,7 +26,7 @@ available in your environemnt. In the Blue Brain clusters you have two possibilities depending on the Python version you want to use: * For Python 3.4: ``module load BBP/viz/latest`` - * For Python 2.7: ``module load memcache/bbpviz nix/viz/brion/1.8 nix/python2.7-full`` + * For Python 2.7: ``module load memcache/bbpviz nix/viz/brion/2.0 nix/python2.7-full`` .. code:: python @@ -319,7 +319,7 @@ Some functions also provide access to the low raw data arrays. .. code:: python - # The soma object provides the cenroid, radius and profile points if any. + # The soma object provides the centroid, radius and profile points if any. soma = morphology.soma() print(soma.centroid()) print(soma.mean_radius()) @@ -391,7 +391,7 @@ Some functions also provide access to the low raw data arrays. print("Children:", [s.id() for s in section.children()]) print("Parent:", section.parent()) - # To retrieve the sample locations and radii the method is samples. + # To retrieve the sample locations and diameters the method is samples. print(section.samples()) # This method can take a list of relative position to obtain linearly interpolated sample positions.