Skip to content

Commit e9fa04b

Browse files
authored
chore: fix wording
Language Checks 3
2 parents 7157d81 + 8cc730a commit e9fa04b

File tree

1 file changed

+19
-22
lines changed

1 file changed

+19
-22
lines changed

specs/index.bs

+19-22
Original file line numberDiff line numberDiff line change
@@ -322,14 +322,14 @@ This data transaction enables a [=Transport Service Organizer=] or a [=Transport
322322

323323
To execute this transaction, the [=Transport Operator=] MUST
324324

325-
1. collect Transport Activity Data belonging to a consignment identified by the [=consignment id=]
326-
2. calculate the <{TAD}> (see [[#dt-tad]]) given the [=consignment id=]
327-
3. make the resulting <{TAD}> available through the PACT Network API.
325+
1. collect Transport Activity Data belonging to a consignment identified by the [=consignment id=].
326+
2. make the <{TAD}> available through [[#action-tad]].
328327

329328
The [=Transport Service Organizer=] or [=Transport Service User=] CAN then retrieve the <{TAD|TADs}> using the [=consignment ids=].
330329

331-
Note: This data transaction is considered necessary by logistics parties, especially for SMEs,
332-
lacking the capabilities to report curated emissions data. Through this transaction they can
330+
Note:
331+
This data transaction is considered necessary by logistics parties, especially for SMEs,
332+
lacking the capabilities to make emissions data available. Through this transaction they can
333333
provide activity data to their customers.
334334

335335
# End-to-End Example # {#example}
@@ -343,12 +343,11 @@ The following hypothetical parties are involved:
343343

344344
: Transport Service User `S`
345345
::
346-
A [=Transport Service User=] which wants to calculate the logistics emissions of a shipment from Rotterdam to Prague.
346+
A [=Transport Service User=] wants to calculate the logistics emissions of a shipment from Rotterdam to Prague.
347347
The shipper has a contract with the Transport Service Organizer `Z`.
348348

349349
`S` operates a [=host system=] which implements Transaction 1 ([[#txn1]]) to collect
350-
<{TCE|TCEs}>. Based on the collected <{TCE|TCEs}>, `S` can calculate Transport Chains ([=TCs=]) and
351-
thereby calculate and gain logistics emissions transparency.
350+
<{TCE|TCEs}>. Based on the collected <{TCE|TCEs}>, `S` can calculate the Transport Chain ([=TC=]) emissions.
352351

353352
: Transport Service Organizer `Z`
354353
::
@@ -357,10 +356,9 @@ The following hypothetical parties are involved:
357356
The Transport Service Organizer contracts Transport Operator A and Transport Operator B to perform the transport.
358357

359358
This operator has a [=host system=] which implements Transaction 1 ([[#txn1]])
360-
as well as Transaction 2 ([[#txn2]]).
359+
and Transaction 2 ([[#txn2]]).
361360

362-
Through this, the operator is able to eventually calculate <{TCE|TCEs}> and <{TOC|TOCs}>, so that
363-
they can provide data to Transport Service User `S`.
361+
Through this, the operator is able to calculate <{TCE|TCEs}> and <{TOC|TOCs}>, and provide data to Transport Service User `S`.
364362

365363

366364
: Transport Operator `A`
@@ -376,17 +374,16 @@ The following hypothetical parties are involved:
376374
::
377375
Another [=Transport Operator=] responsible for the second leg of the shipment.
378376

379-
This [=Transport Operator=] is capable of making <{TAD}> data avialable to the
377+
This [=Transport Operator=] is capable of making <{TAD}> data available to the
380378
[=Transport Service Organizer=] Z.
381379

382380

383381
## Data Transactions Executed ## {#example-txns}
384382

385-
Note: In this hypothetical example, hub operations are currently ommitted.
383+
Note: This hypothetical example currently ommits hub operations.
386384

387385
Note: In this hypothetical example, when we refer to a party executing a transaction,
388-
we implicitly refer to their [=host systems=] which execute
389-
the tasks and transactions on their behalf.
386+
we implicitly refer to the [=host systems=] executing the tasks and transactions on their behalf.
390387

391388

392389
### Data Collection by Transport Service Organizer `Z` ### {#example-z}
@@ -399,7 +396,7 @@ For this, the Transport Service Organizer `Z` performs the following data transa
399396
for the first leg of the shipment.
400397
1. As Transport Operator `B` does not support [[#txn1]], `Z` performs [[#txn3]] with
401398
Transport Operator `B` to collect the <{TAD}> for the second leg of the shipment.
402-
1. `Z` then calculates the <{TCE|TCEs}> for the 2nd leg of the shipment based on
399+
1. `Z` then calculates the <{TCE|TCEs}> for the second leg of the shipment based on
403400
the <{TAD}> data and modelled or default emission factors.
404401

405402
### Data Collection by Transport Service User `S` ### {#example-s}
@@ -409,7 +406,7 @@ can calculate the logistics emissions of the shipment by
409406

410407
1. collecting the <{TCE|TCEs}> from `Z` using the [=shipment id=] and [[#txn1]], storing the resulting <{TCE|TCEs}> in e.g. its database.
411408
1. `S` can further verify the <{TCE|TCEs}> by collecting the <{TOC|TOCs}> from `Z` using [[#txn2]].
412-
1. To compute the logistics emissions, `Z` can add up the <{TCE|TCEs}> from step 1.
409+
1. `Z` can form the [=TC=] by adding up the <{TCE|TCEs}> from step 1.
413410

414411

415412
## Example HTTP Calls ## {#example-http}
@@ -419,8 +416,8 @@ can calculate the logistics emissions of the shipment by
419416
To collect the <{TCE|TCEs}> from Transport Operator `A`, `Z` performs the following HTTP call.
420417

421418
Note: The call to `/footprints` can return several footprints, 1 for each shipment.
422-
By filtering, e.g. by the shipment id, `Z` can retrieve the <{TCE|TCEs}> for
423-
the shipment of interest (not shown below).
419+
By filtering, e.g. by shipment id, `Z` can retrieve the <{TCE|TCEs}> for
420+
the shipment of interest. The use of this functionality is not included in the example below.
424421

425422
The highlighted lines show the data exchanged according to the <{ShipmentFootprint}> data model.
426423

@@ -500,11 +497,11 @@ The highlighted lines show the data exchanged according to the <{ShipmentFootpri
500497

501498
### Data Collection by Transport Service User `S` ### {#example-http-s}
502499

503-
To collect the TCEs data related to the shipment from Transport Organizer `Z`, `S` performs the following HTTP call which yields 2 TCEs.
500+
To collect the TCE data related to the shipment from Transport Organizer `Z`, `S` performs the following HTTP call, which yields 2 TCEs.
504501

505502
Note: The call to `/footprints` can return several footprints, 1 for each shipment.
506-
By filtering, e.g. by the shipment id, `Z` can retrieve the <{TCE|TCEs}>
507-
for the shipment of interest (not shown below).
503+
By filtering, e.g. by shipment id, `Z` can retrieve the <{TCE|TCEs}>
504+
for the shipment of interest. The use of this functionality is not included in the example below.
508505

509506
The highlighted lines show 2 TCEs which `Z` has collected and calculated for `S`.
510507

0 commit comments

Comments
 (0)