Skip to content

Commit ba7d7ce

Browse files
author
Alan Christie
committed
Doc tweak
1 parent 8638dfc commit ba7d7ce

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

README.rst

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,28 +5,28 @@ Informatics Matters Data Manager Job Utilities
55
:target: https://badge.fury.io/py/im-data-manager-job-utilities
66
:alt: PyPI package (latest)
77

8-
A package that simplifies the generation of *events* and *cost lines*
9-
written to the Job stdout stream.
8+
A package that simplifies the generation of *events* and *cost* lines
9+
written to the Job's stdout stream.
1010

11-
The following utilities are supported: -
11+
The following utilities are available: -
1212

13-
- DmLog.emit_event()
14-
- DmLog.emit_cost()
13+
- ``DmLog.emit_event()``
14+
- ``DmLog.emit_cost()``
1515

1616
Installation (Python)
1717
=====================
1818

19-
The Job decoder is published on `PyPI`_ and can be installed from
19+
The Job utilities are published on `PyPI`_ and can be installed from
2020
there::
2121

2222
pip install im-data-manager-job-utilities
2323

24-
Once installed you can use the utilities using the supplied classes::
24+
Once installed you can use the available classes::
2525

2626
>>> from dm_job_utilities.dm_log import DmLog
27-
>>> from decimal import Decimal
2827
>>> DmLog.emit_event('Hello World!')
2928
2022-02-03T16:39:27+00:00 # INFO -EVENT- Hello World!
29+
>>> from decimal import Decimal
3030
>>> DmLog.emit_cost(Decimal('5.7'))
3131
2022-02-03T16:40:16+00:00 # INFO -COST- 5.7 1
3232

@@ -37,8 +37,9 @@ Costs are *total* by default but can be issued as an incremental value::
3737
2022-02-03T16:40:16+00:00 # INFO -COST- +0.5 2
3838

3939

40-
The final value on the COST line is a unique sequence number. This value
41-
is required and is used by the Data Manager to avoid duplicating costs.
40+
The final value on each cost line is a unique sequence number. This value
41+
is typically an integer that increments with each line. It is required and
42+
is used by the Data Manager to avoid duplicating costs.
4243

4344
.. _PyPI: https://pypi.org/project/im-data-manager-job-utilities
4445

0 commit comments

Comments
 (0)