Changeset ac7be54 in sasview for src/sas/data_util/uncertainty.py

Timestamp:

May 8, 2015 2:27:08 PM (10 years ago)

Author:

Paul Kienzle <pkienzle@…>

Branches:

master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload

Children:

5e880fe1

Parents:

c22c5e3

Message:

fix sphinx errors in api manual

File:

• src/sas/data_util/uncertainty.py (modified) (2 diffs)

src/sas/data_util/uncertainty.py

@@ -1 @@
-"""
-
-Uncertainty propagation class, and log() and exp() functions.
+r"""
+Uncertainty propagation class for arithmetic, log and exp.
 
 Based on scalars or numpy vectors, this class allows you to store and 
 manipulate values+uncertainties, with propagation of gaussian error for
-addition, subtraction, multiplication, division, power, exp() and log().
+addition, subtraction, multiplication, division, power, exp and log.
 
 Storage properties are determined by the numbers used to set the value
@@ -11 +10 @@
 for inplace operations since numpy does not do automatic type conversion.
 Normal operations can use mixed integer and floating point.  In place
-operations (a *= b, etc.) create at most one extra copy for each operation.
-c = a*b by contrast uses four intermediate vectors, so shouldn't be used
+operations such as *a \*= b* create at most one extra copy for each operation.
+By contrast, *c = a\*b* uses four intermediate vectors, so shouldn't be used
 for huge arrays.
 """