Skip to content

Commit eb55c46

Browse files
author
James McKinney
committed
Fix Markdown warnings
1 parent 9c66f06 commit eb55c46

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
Enquiries
2-
========================
1+
# Enquiries
32

43
The enquiries extension can be used to record questions raised during a contracting process, and the answers provided.
54

@@ -30,26 +29,26 @@ Example:
3029
}
3130
```
3231

33-
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'.
3433

35-
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.
3635

3736
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.
3837

3938
## Usage guidance
4039

41-
Implementations may vary on the amount of enquiry information they provide, and when it is provided.
40+
Implementations may vary on the amount of enquiry information they provide, and when it is provided.
4241

4342
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.)
4443

45-
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.
4645

4746
Where possible, the recommended approach is to:
4847

4948
* 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;
5049
* 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;
5150

52-
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.
51+
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.
5352

5453
We recommend that publishers provide question answers as plain text, or with minimal HTML markup (paragraphs and line-breaks), and that consuming applications parse text appropriately to format it for readability (e.g. replace line-breaks with paragraph breaks in HTML).
5554

0 commit comments

Comments
 (0)