Updates release notes for PR #3978

ponylang · Feb 1, 2022 · e581d85 · e581d85
1 parent 3fdddf2
commit e581d85
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 7 deletions.
diff --git a/.release-notes/next-release.md b/.release-notes/next-release.md
@@ -113,3 +113,11 @@ As far as we know, there are two codebases that will be impacted by this change:
 
 This release fixes a compiler assertion failure being triggered when one attempted to assign an error expression surrounded by parenthesis to a variable.
 
+##  Add "nodoc" annotation
+
+The can be used to control the pony compilers documentation generation, any structure that can have a docstring (except packages) can be annotated with \nodoc\ to prevent documentation from being generated.
+
+This replaces a hack that has existed in the documentation generation system for several years to filter out items that were "for testing" by looking for Test and _Test at the beginning of the name as well as providing UnitTest or TestList.
+
+Note that the "should we include this package" hack to filter oupackages called "test" and "builtin_test" still exists for the timbeing until we have further discussion.
+
diff --git a/.release-notes/nodoc.md b/.release-notes/nodoc.md