diff options
Diffstat (limited to 'dev/NEWS-FORMAT.md')
| -rw-r--r-- | dev/NEWS-FORMAT.md | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/dev/NEWS-FORMAT.md b/dev/NEWS-FORMAT.md index f856f78127..9807c41bad 100644 --- a/dev/NEWS-FORMAT.md +++ b/dev/NEWS-FORMAT.md @@ -133,6 +133,22 @@ possible and practical. List features in descending order of significance (approximately). +#### Listing known issues + +Known issues can be called out as follows: + +```text +The following known issues are present in this release and will be rectified in +a future release: + + * xxx (#12345) + +``` + +The editorial conventions for this block are similar to those for feature +additions, except that an issue number is listed rather than a reference to a +standard. + #### Listing documentation enhancements Significant documentation enhancements can be called out as follows: |