code-annotations 2.0.0__tar.gz → 2.1.0__tar.gz

{code_annotations-2.0.0 → code_annotations-2.1.0}/CHANGELOG.rst

@@ -14,6 +14,11 @@ Change Log
 Unreleased
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+[2.1.0] - 2024-12-12
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* Add support for optional event warning for in-line annotation.
+
 [2.0.0] - 2024-10-18
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

{code_annotations-2.0.0 → code_annotations-2.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: code-annotations
-Version: 2.0.0
+Version: 2.1.0
 Summary: Extensible tools for parsing annotations in codebases
 Home-page: https://github.com/openedx/code-annotations
 Author: edX
@@ -23,9 +23,9 @@ License-File: LICENSE.txt
 License-File: NOTICE.txt
 Requires-Dist: python-slugify
 Requires-Dist: stevedore
-Requires-Dist: Jinja2
-Requires-Dist: click
 Requires-Dist: pyyaml
+Requires-Dist: click
+Requires-Dist: Jinja2
 Provides-Extra: django
 Requires-Dist: Django>=4.2; extra == "django"
 
@@ -129,6 +129,11 @@ Change Log
 Unreleased
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+[2.1.0] - 2024-12-12
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* Add support for optional event warning for in-line annotation.
+
 [2.0.0] - 2024-10-18
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

{code_annotations-2.0.0 → code_annotations-2.1.0}/code_annotations/__init__.py

@@ -2,4 +2,4 @@
 Extensible tools for parsing annotations in codebases.
 """
 
-__version__ = '2.0.0'
+__version__ = '2.1.0'

{code_annotations-2.0.0 → code_annotations-2.1.0}/code_annotations/contrib/config/openedx_events_annotations.yaml

@@ -6,12 +6,13 @@ safelist_path: .annotation_safe_list.yml
 coverage_target: 100.0
 annotations:
   feature_toggle:
-    # See annotation format documentation: https://edx-toggles.readthedocs.io/en/latest/how_to/documenting_new_feature_toggles.html
+    # See annotation format documentation: https://docs.openedx.org/projects/openedx-events/en/latest/reference/in-line-code-annotations-for-an-event.html
     - ".. event_type:":
     - ".. event_name:":
     - ".. event_description:":
     - ".. event_data:":
     - ".. event_key_field:":
+    - ".. event_warning:":
 extensions:
     python:
         - py

{code_annotations-2.0.0 → code_annotations-2.1.0}/code_annotations/contrib/sphinx/extensions/openedx_events.py

@@ -118,6 +118,11 @@ class OpenedxEvents(SphinxDirective):
                      f" {event['line_number']})"
             )
 
+            if event.get(".. event_warning:") not in (None, "None", "n/a", "N/A"):
+                event_section += nodes.warning(
+                    "", nodes.paragraph("", event[".. event_warning:"]), ids=[f"warning-{event_name}"]
+                )
+
             subject_header += event_section
 
         if domain_header:

{code_annotations-2.0.0 → code_annotations-2.1.0}/code_annotations.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: code-annotations
-Version: 2.0.0
+Version: 2.1.0
 Summary: Extensible tools for parsing annotations in codebases
 Home-page: https://github.com/openedx/code-annotations
 Author: edX
@@ -23,9 +23,9 @@ License-File: LICENSE.txt
 License-File: NOTICE.txt
 Requires-Dist: python-slugify
 Requires-Dist: stevedore
-Requires-Dist: Jinja2
-Requires-Dist: click
 Requires-Dist: pyyaml
+Requires-Dist: click
+Requires-Dist: Jinja2
 Provides-Extra: django
 Requires-Dist: Django>=4.2; extra == "django"
 
@@ -129,6 +129,11 @@ Change Log
 Unreleased
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+[2.1.0] - 2024-12-12
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* Add support for optional event warning for in-line annotation.
+
 [2.0.0] - 2024-10-18
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

{code_annotations-2.0.0 → code_annotations-2.1.0}/code_annotations.egg-info/requires.txt

@@ -1,8 +1,8 @@
 python-slugify
 stevedore
-Jinja2
-click
 pyyaml
+click
+Jinja2
 
 [django]
 Django>=4.2