Skip to content

Commit 16efcc0

Browse files
authored
Merge pull request #12 from open-contracting/backticks
2 parents 8507559 + e7e52ab commit 16efcc0

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The enquiries extension can be used to record questions raised during a contract
44

55
## Structure
66

7-
The extension adds an ```enquiries``` array to tender, consisting of one or more enquiry objects, each with fields for a question, and an answer.
7+
The extension adds an `enquiries` array to tender, consisting of one or more enquiry objects, each with fields for a question, and an answer.
88

99
Example:
1010

@@ -29,24 +29,24 @@ Example:
2929
}
3030
```
3131

32-
Supporting documents with clarifications, or a full document containing answers to questions can be included in the ```tender/documents``` array with a ```documentType``` of 'clarifications'.
32+
Supporting documents with clarifications, or a full document containing answers to questions can be included in the `tender/documents` array with a `documentType` of 'clarifications'.
3333

34-
Where the answers to a question are only available in attached documents, an ```answer``` value such as 'Consult section N of "%document name%" in the documents section' may be entered to allow analysts of the data to identify that an answer to this question has been provided.
34+
Where the answers to a question are only available in attached documents, an `answer` value such as 'Consult section N of "%document name%" in the documents section' may be entered to allow analysts of the data to identify that an answer to this question has been provided.
3535

36-
When a system allow a discussion format, where each answer can be followed by a further clarification question, the ```threadID``` property can be used to link together multiple entries in the ```enquiries``` array.
36+
When a system allow a discussion format, where each answer can be followed by a further clarification question, the `threadID` property can be used to link together multiple entries in the `enquiries` array.
3737

3838
## Usage guidance
3939

4040
Implementations may vary on the amount of enquiry information they provide, and when it is provided.
4141

4242
Some publishers may omit the identity of the question author to protect confidentiality of enquirers, or may anonymize this information (e.g. simply putting the author name as 'Organization 1' or 'Organization 2' so that it is possible to see questions from the same organization, but not to know the identity of that organization.)
4343

44-
The ```relatedItem``` and ```relatedLot``` properties are available for use when questions can be asked in relation to a specific lot or item.
44+
The `relatedItem` and `relatedLot` properties are available for use when questions can be asked in relation to a specific lot or item.
4545

4646
Where possible, the recommended approach is to:
4747

48-
* Make release with a ```tenderUpdate``` release tag for every new question or batch of questions received, providing an enquiries array with each of the questions in;
49-
* Make a release with a ```tenderUpdate``` release tag when the answers to the questions are provided, updating the earlier enquiries array so each entry now contains both a question and an answer;
48+
* Make release with a `tenderUpdate` release tag for every new question or batch of questions received, providing an enquiries array with each of the questions in;
49+
* Make a release with a `tenderUpdate` release tag when the answers to the questions are provided, updating the earlier enquiries array so each entry now contains both a question and an answer;
5050

5151
This approach will enable third-party applications to watch for releases that provide answers to questions, and will support procurement monitors in reviewing the way in which questions are being answered.
5252

0 commit comments

Comments
 (0)