Dev: ra

Author: liangxin1300

crmsh/ra.py

@@ -428,9 +428,12 @@ def params(self):
                 "longdesc": get_nodes_text(param, "longdesc")
             }
 
-        # Sort the dictionary by required and then alphabetically
         items = list(params_dict.items())
-        items.sort(key=lambda x: (x[1]["required"] != "1", x[0]))
+        # Sort the dictionary by:
+        # 1. Required parameters first
+        # 2. Alphabetically by name
+        # 3. Deprecated parameters last
+        items.sort(key=lambda x: (x[1]["deprecated"] == "1", x[1]["required"] != "1", x[0]))
         params_dict = dict(items)
 
         return cache.store(ident, params_dict)
@@ -766,6 +769,13 @@ def format_parameter(self, name: str, parameter_dict: dict) -> str:
 
         def format_header(name: str, parameter_dict: dict) -> str:
             header_str = f"{name}"
+            if parameter_dict.get("required") == "1":
+                header_str += "*"
+            if parameter_dict.get("deprecated") == "1":
+                header_str += " (deprecated)"
+            obsoletes = parameter_dict.get("obsoletes")
+            if obsoletes:
+                header_str += f" (obsoletes: {obsoletes})"
 
             typ, default = parameter_dict.get("type"), parameter_dict.get("default")
             if typ and default:
@@ -774,18 +784,13 @@ def format_header(name: str, parameter_dict: dict) -> str:
                 header_str += f" ({typ}):"
 
             attr_str_map = {
-                "required": "Required",
                 "advanced": "Advanced Use Only",
-                "generated": "Automatically generated by pacemaker",
-                "deprecated": "Deprecated"
+                "generated": "Automatically generated by pacemaker"
             }
             attr_str_list = [
                 desc for attr, desc in attr_str_map.items()
                 if parameter_dict.get(attr) == "1"
             ]
-            obsoletes = parameter_dict.get("obsoletes")
-            if obsoletes:
-                attr_str_list.append(f"Obsoletes {obsoletes}")
             if attr_str_list:
                 header_str += f" *** {'; '.join(attr_str_list)} ***"
 
@@ -836,7 +841,7 @@ def meta_parameters(self) -> str:
             if res:
                 parameter_str_list.append(res)
         if parameter_str_list:
-            return "## Parameters (type, [default]):\n\n" + '\n'.join(parameter_str_list)
+            return "## Parameters (*: required, []: default):\n\n" + '\n'.join(parameter_str_list)
 
     def meta_actions(self):
         def meta_action_head(n):