godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-12-06 17:25:19 +00:00
Code Releases Wiki Activity

Documentation: Treat deprecated/experimental members as documented

Browse Source
This commit is contained in:
Danil Alexeev
2024-02-16 16:28:05 +03:00
parent a9bb8509f2
commit 12c86c6716
3 changed files with 262 additions and 203 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
doc/tools/doc_status.py
View File

@@ -279,13 +279,18 @@ class ClassStatus:
elif tag.tag in ["methods", "signals", "operators", "constructors"]:
for sub_tag in list(tag):
is_deprecated = "deprecated" in sub_tag.attrib
is_experimental = "experimental" in sub_tag.attrib
descr = sub_tag.find("description")
increment = (descr is not None) and (descr.text is not None) and len(descr.text.strip()) > 0
status.progresses[tag.tag].increment(increment)
has_descr = (descr is not None) and (descr.text is not None) and len(descr.text.strip()) > 0
status.progresses[tag.tag].increment(is_deprecated or is_experimental or has_descr)
elif tag.tag in ["constants", "members", "theme_items"]:
for sub_tag in list(tag):
if not sub_tag.text is None:
status.progresses[tag.tag].increment(len(sub_tag.text.strip()) > 0)
is_deprecated = "deprecated" in sub_tag.attrib
is_experimental = "experimental" in sub_tag.attrib
has_descr = len(sub_tag.text.strip()) > 0
status.progresses[tag.tag].increment(is_deprecated or is_experimental or has_descr)
elif tag.tag in ["tutorials"]:
pass # Ignore those tags for now