Skip to content

Commit

Permalink
docs(chore): Use "example" not "worked example" open-contracting/stan…
Browse files Browse the repository at this point in the history
  • Loading branch information
jpmckinney committed Mar 28, 2024
1 parent 97bc0da commit 4c5f24f
Show file tree
Hide file tree
Showing 10 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion docs/guidance/map/amendments.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The nature of a change can be made explicit using:

* **The amendments** fields (`tender.amendments`, `awards.amendments` and `contracts.amendments`), which are used to list amendments along with their rationales and references to the releases that contain "before" and "after" values.

## Worked examples
## Examples

### Example 1: Tender updates and amendments

Expand Down
2 changes: 1 addition & 1 deletion docs/guidance/map/beneficial_ownership.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

# Beneficial ownership information

This worked example describes how to:
This example describes how to:

* publish separate contracting and beneficial ownership datasets
* publish beneficial ownership data using OCDS
Expand Down
2 changes: 1 addition & 1 deletion docs/guidance/map/framework_agreements.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ The following guidance describes how to model the different stages of a framewor
* Add an `Organization` object to the `parties` array, add 'supplier' to its `.roles` and populate its other fields.
* Add an `OrganizationReference` object to the award's `.suppliers` array and set `.id` and `.name` to match the supplier's object in the `parties` array.

## Worked examples
## Examples

The following examples show how to model two framework agreements, covering a range of characteristics:

Expand Down
2 changes: 1 addition & 1 deletion docs/guidance/map/linked_standards.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ The [Open Fiscal Data Package](https://www.fiscaltransparency.net/open-fiscal-da

## Beneficial Ownership Data Standard

The [Beneficial Ownership Data Standard](https://standard.openownership.org/en/0.2.0/) (BODS) provides a structured data format for collecting, sharing and using data on beneficial ownership. The [beneficial ownership worked example](beneficial_ownership) describes how to connect OCDS and BODS datasets.
The [Beneficial Ownership Data Standard](https://standard.openownership.org/en/0.2.0/) (BODS) provides a structured data format for collecting, sharing and using data on beneficial ownership. The [beneficial ownership example](beneficial_ownership) describes how to connect OCDS and BODS datasets.
6 changes: 3 additions & 3 deletions docs/guidance/map/milestones.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,9 @@ The `dueDate`, `dateMet`, `dateModified` and [`status`](../../schema/codelists.m

To represent a planned payment, add a `Milestone`, set its `.type` to 'payment' and set its `.value` to the payment's value. Once the milestone is met, add a [Transaction](../../schema/reference.md#transaction) to `contracts/implementation/transactions`. For implementation milestones, the transaction can refer back to the milestone using the [transaction-related milestones extension](https://extensions.open-contracting.org/en/extensions/transaction_milestones/master/).

## Worked examples
## Examples

The following worked examples show how milestones are modelled.
The following examples show how milestones are modelled.

### Planning milestones

Expand All @@ -56,7 +56,7 @@ Because the approval relates to a planning process, it is modelled as a mileston

### Delivery milestones

This worked example shows how delivery milestones are modelled.
This example shows how delivery milestones are modelled.

#### Implementation release

Expand Down
2 changes: 1 addition & 1 deletion docs/guidance/map/organization_classifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ In either case, your [publication policy](../publish.md#finalize-your-publicatio
Future versions of OCDS might add standardized fields like `parties.details.scale` to disclose classifications. If a new field matches the semantics of a classification that you already publish using the organization classifications extension, in order to preserve backwards compatibility, you can publish both the standardized field and the extension fields.
```

## Worked examples
## Examples

### Organization scale

Expand Down
2 changes: 1 addition & 1 deletion docs/guidance/map/organization_identifiers.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ To disclose an organization identifier, first, use [org-id.guide](http://org-id.

If you choose not to register an organization list with org-id.guide, you ought to describe the list in a [publication policy](../publish.md#finalize-your-publication-policy), and select a prefix that is not in use by another list in org-id.guide, by following the [org-id meta-data guide](http://docs.org-id.guide/en/latest/metadata/#assigning-a-code).

## Worked example
## Example

A publisher in the United Kingdom collects [Companies House](https://www.gov.uk/government/organisations/companies-house) numbers as its primary organization identifiers for suppliers.

Expand Down
2 changes: 1 addition & 1 deletion docs/guidance/map/organization_personal_identifiers.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ To construct a `scheme` value for a personal identifier, follow the [guidance](h

> the scheme should have the pattern {JURISDICTION}-{TYPE} where JURISDICTION is an uppercase ISO 3166-1 alpha-3 country code and TYPE is one of PASSPORT, TAXID or IDCARD
## Worked example
## Example

A publisher in Colombia collects national ID card numbers as identifiers for natural persons who are tenderers or suppliers.

Expand Down
2 changes: 1 addition & 1 deletion docs/guidance/map/organizational_units.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ If the fields in the `Organization` object are not sufficient to express your da

Disclosing organizational hierarchies in OCDS is strongly discouraged unless there is a clear use case to support it. Ideally, organizational hierarchies ought to be represented in separate, non-OCDS datasets that use the same organization and unit identifiers. To design a hierarchy-oriented dataset, refer to the [W3C Organization Ontology](https://www.w3.org/TR/vocab-org/). However, if you need to represent organizational hierarchies in OCDS, you can use the [memberOf extension](https://github.com/open-contracting-extensions/ocds_memberOf_extension).

## Worked examples
## Examples

### Using the Organization object

Expand Down
2 changes: 1 addition & 1 deletion docs/guidance/map/pre-qualification.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ But, many jurisdictions also use multi-stage procedures. Such procedures follow
:file: ../../examples/pre-qualification/multi-stage.csv
```

This worked example describes 3 types of multi-stage procedure and explains how to model them in OCDS.
This example describes 3 types of multi-stage procedure and explains how to model them in OCDS.

## Definitions

Expand Down

0 comments on commit 4c5f24f

Please sign in to comment.