example_conflicts.json 3.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142
  1. {
  2. "conflicts": [
  3. {
  4. "type": "missing_in_docs",
  5. "severity": "medium",
  6. "api_name": "Node2D",
  7. "docs_info": null,
  8. "code_info": {
  9. "name": "Node2D",
  10. "type": "class",
  11. "source": "scene/node2d.py",
  12. "line": 10,
  13. "base_classes": [
  14. "Node"
  15. ],
  16. "docstring": "Base class for 2D nodes"
  17. },
  18. "difference": "API exists in code (scene/node2d.py) but not found in documentation",
  19. "suggestion": "Add documentation for this API"
  20. },
  21. {
  22. "type": "missing_in_docs",
  23. "severity": "medium",
  24. "api_name": "Node2D.move_local_x",
  25. "docs_info": null,
  26. "code_info": {
  27. "name": "Node2D.move_local_x",
  28. "type": "method",
  29. "parameters": [
  30. {
  31. "name": "self",
  32. "type_hint": null,
  33. "default": null
  34. },
  35. {
  36. "name": "delta",
  37. "type_hint": "float",
  38. "default": null
  39. },
  40. {
  41. "name": "snap",
  42. "type_hint": "bool",
  43. "default": "False"
  44. }
  45. ],
  46. "return_type": "None",
  47. "source": "scene/node2d.py",
  48. "line": 45,
  49. "docstring": "Move node along local X axis",
  50. "is_async": false
  51. },
  52. "difference": "API exists in code (scene/node2d.py) but not found in documentation",
  53. "suggestion": "Add documentation for this API"
  54. },
  55. {
  56. "type": "missing_in_docs",
  57. "severity": "medium",
  58. "api_name": "Node2D.tween_position",
  59. "docs_info": null,
  60. "code_info": {
  61. "name": "Node2D.tween_position",
  62. "type": "method",
  63. "parameters": [
  64. {
  65. "name": "self",
  66. "type_hint": null,
  67. "default": null
  68. },
  69. {
  70. "name": "target",
  71. "type_hint": "tuple",
  72. "default": null
  73. }
  74. ],
  75. "return_type": "None",
  76. "source": "scene/node2d.py",
  77. "line": 52,
  78. "docstring": "Animate to target position",
  79. "is_async": true
  80. },
  81. "difference": "API exists in code (scene/node2d.py) but not found in documentation",
  82. "suggestion": "Add documentation for this API"
  83. },
  84. {
  85. "type": "missing_in_code",
  86. "severity": "high",
  87. "api_name": "move_local_x",
  88. "docs_info": {
  89. "name": "move_local_x",
  90. "parameters": [
  91. {
  92. "name": "delta",
  93. "type": "float",
  94. "default": null
  95. }
  96. ],
  97. "return_type": "def",
  98. "source": "https://example.com/api/node2d",
  99. "raw_signature": "def move_local_x(delta: float)"
  100. },
  101. "code_info": null,
  102. "difference": "API documented (https://example.com/api/node2d) but not found in code",
  103. "suggestion": "Update documentation to remove this API, or add it to codebase"
  104. },
  105. {
  106. "type": "missing_in_code",
  107. "severity": "high",
  108. "api_name": "rotate",
  109. "docs_info": {
  110. "name": "rotate",
  111. "parameters": [
  112. {
  113. "name": "angle",
  114. "type": "float",
  115. "default": null
  116. }
  117. ],
  118. "return_type": "def",
  119. "source": "https://example.com/api/node2d",
  120. "raw_signature": "def rotate(angle: float)"
  121. },
  122. "code_info": null,
  123. "difference": "API documented (https://example.com/api/node2d) but not found in code",
  124. "suggestion": "Update documentation to remove this API, or add it to codebase"
  125. }
  126. ],
  127. "summary": {
  128. "total": 5,
  129. "by_type": {
  130. "missing_in_docs": 3,
  131. "missing_in_code": 2,
  132. "signature_mismatch": 0,
  133. "description_mismatch": 0
  134. },
  135. "by_severity": {
  136. "low": 0,
  137. "medium": 3,
  138. "high": 2
  139. },
  140. "apis_affected": 5
  141. }
  142. }