diff options
| author | nevimov <nevimov@gmail.com> | 2016-04-28 00:23:34 +0700 |
|---|---|---|
| committer | nevimov <nevimov@gmail.com> | 2016-04-28 01:08:26 +0700 |
| commit | 4be3c23a11a4725cc4b074992fef90f8ba163c5f (patch) | |
| tree | aed21a308cc1feb826c8f81cc6bbeae8cab06de6 | |
| parent | 1b6831be8dc33308e77f3d3253f5ee777e3bb178 (diff) | |
| download | numpy-4be3c23a11a4725cc4b074992fef90f8ba163c5f.tar.gz | |
DOC: clarify purpose of Attributes section
According to the official Python documentation, term "class variables"
denotes attributes shared by all instances of the class. The current
version of the Numpy/Scipy documentation guide uses the term to mean
non-method attributes. This commit replaces the confusing term with a
more appropriate one.
| -rw-r--r-- | doc/HOWTO_DOCUMENT.rst.txt | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/HOWTO_DOCUMENT.rst.txt b/doc/HOWTO_DOCUMENT.rst.txt index 721835013..9976da1e0 100644 --- a/doc/HOWTO_DOCUMENT.rst.txt +++ b/doc/HOWTO_DOCUMENT.rst.txt @@ -461,7 +461,7 @@ here, the **Parameters** section of the docstring details the constructors parameters. An **Attributes** section, located below the **Parameters** section, -may be used to describe class variables:: +may be used to describe non-method attributes of the class:: Attributes ---------- |