docs: using : syntax instead of :

Author: clatapie

doc/source/user_guide/source_code.rst

@@ -146,21 +146,21 @@ into account and added to the Python docstring:
 
                 Parameters
                 ----------
-                nl1 : str
+                nl1: str
                     Number of the first line to be hit (touched by the end of the new line). If negative, assume ``P1`` (see below) is the second keypoint of the line instead of the first
-                nl2 : str
+                nl2: str
                     Number of the second line to be hit. If negative, assume ``P3`` is the second keypoint of the line instead of the first.
 
-                ang1 : str
+                ang1: str
                     Angle of intersection (usually zero or 180) of generated line with tangent to first line.
 
-                ang2 : str
+                ang2: str
                     Angle of intersection (usually zero or 180) of generated line with tangent to second line.
 
-                phit1 : str
+                phit1: str
                     Number to be assigned to keypoint generated at hit location on first line (defaults to lowest available keypoint number ( :ref:`numstr` )).
 
-                phit2 : str
+                phit2: str
                     Number to be assigned to keypoint generated at hit location on second line (defaults to lowest available keypoint number ( :ref:`numstr` )).
 
                 Returns

src/pyconverter/xml2py/ast_tree.py

@@ -2166,7 +2166,10 @@ class Argument:
     """Argument object."""
 
     def __init__(
-        self, element: str | Element, initial_argument: List, description: Element | str | None = None
+        self,
+        element: str | Element,
+        initial_argument: List,
+        description: Element | str | None = None,
     ) -> None:
         if description is None:
             if isinstance(element[0], Term):
@@ -2371,7 +2374,11 @@ def to_py_docstring(
                 rst_description = self._description
             else:
                 rst_description = self._description.to_rst(
-                    indent=indent, max_length=max_length, links=links, base_url=base_url, fcache=fcache
+                    indent=indent,
+                    max_length=max_length,
+                    links=links,
+                    base_url=base_url,
+                    fcache=fcache,
                 )
             description_indent = " " * 4 + indent
             if not "* " in rst_description:
@@ -2468,15 +2475,15 @@ def arg_desc(self) -> List[Argument]:
                         arguments = ArgumentList(elem, self.args)
                     else:
                         arguments += ArgumentList(elem, self.args)
-        
+
         if arguments is not None:
             if len(arguments.py_arg_names) < len(arguments.initial_args):
                 for arg in arguments.initial_args:
                     if arg not in arguments.py_arg_names:
                         new_arg = Argument(arg, arguments.initial_args, "")
                         if new_arg.py_arg_name != "":
                             arguments.arguments.append(new_arg)
-        
+
             return arguments.arguments
 
         else:

src/pyconverter/xml2py/custom_functions.py

@@ -31,7 +31,7 @@ def get_docstring_lists(filename: str) -> Tuple[list[str], list[str], list[str],
 
     Parameters
     ----------
-    filename : str
+    filename: str
         Path containing the Python file.
 
     Returns

src/pyconverter/xml2py/directory_format.py

@@ -61,18 +61,18 @@ def get_paths(
 
     Parameters
     ----------
-    path : Path
+    path: Path
         Path object of the directory with the predefined format.
-    graph_path : Path, optional
+    graph_path: Path, optional
         Path object of the directory containing the graphics. The default is ``None``,
         in which case the XML predefined directory format is used.
-    link_path : Path, optional
+    link_path: Path, optional
         Path object of the directory containing the links. The default is ``None``,
         in which case the XML predefined directory format is used.
-    term_path : Path, optional
+    term_path: Path, optional
         Path object of the directory containing the terms. The default is ``None``,
         in which case the XML predefined directory format is used.
-    xml_path : Path, optional
+    xml_path: Path, optional
         Path object of the directory containing the XML files. The default is ``None``,
         in which case the XML predefined directory format is used.
 

src/pyconverter/xml2py/load_xml_doc.py

@@ -37,7 +37,7 @@ def load_links(link_path: Path) -> dict:
 
     Parameters
     ----------
-    link_path : Path
+    link_path: Path
         Path to the links directory.
 
     Returns
@@ -85,7 +85,7 @@ def load_fcache(graph_path: Path) -> dict:
 
     Parameters
     ----------
-    graph_path : Path
+    graph_path: Path
         Path object of the graphic directory.
 
     Returns
@@ -109,7 +109,7 @@ def load_docu_global(term_path: Path) -> dict:
 
     Parameters
     ----------
-    term_path : Path
+    term_path: Path
         Path object of the terms directory.
 
     Returns
@@ -160,24 +160,24 @@ def load_terms(
 
     Parameters
     ----------
-    term_path : Path
+    term_path: Path
         Path object of the terms directory.
-    docu_global : dict
+    docu_global: dict
         Dictionary containing the entity names from the documentation and their path.
-    links : dict
+    links: dict
         Dictionary containing the link names and the needed information to render the links.
-    fcache : dict
+    fcache: dict
         Dictionary containing the base names of the graphics and their path.
-    variable_file : str, optional
+    variable_file: str, optional
         Name of the file containing the variable terms to import.
         The default value is ``"build_variables.ent"``.
-    global_terms_file : str, optional
+    global_terms_file: str, optional
         Name of the file containing the global terms to import.
         The default is ``"terms_global.ent"``.
-    manual_file : str, optional
+    manual_file: str, optional
         Name of the file containing the manual entities to import.
         The default is ``"manuals.ent"``.
-    character_directory : str, optional
+    character_directory: str, optional
         Name of the directory containg the entities for the special characters.
         The default is ``"ent"``.
 

src/pyconverter/xml2py/utils/utils.py

@@ -33,7 +33,7 @@ def parse_yaml(yaml_path: Path) -> dict:
 
     Parameters
     ----------
-    yaml_path : Path
+    yaml_path: Path
         Path object of the YAML file.
 
     Returns
@@ -55,9 +55,9 @@ def get_config_data_value(yaml_path: Path, value: str) -> Union[str, dict, list,
 
     Parameters
     ----------
-    yaml_path : Path
+    yaml_path: Path
         Path object of the YAML file.
-    value : str
+    value: str
         Key to search for in the YAML file.
     """
     config_data = parse_yaml(yaml_path)
@@ -70,9 +70,9 @@ def create_name_map(meta_command: list[str], yaml_file_path: Path) -> dict:
 
     Parameters
     ----------
-    meta_command : list[str]
+    meta_command: list[str]
         List of command names.
-    yaml_file_path : Path
+    yaml_file_path: Path
         Path object of the YAML file.
 
     Returns
@@ -141,11 +141,11 @@ def import_handler(
 
     Parameters
     ----------
-    filename : Path
+    filename: Path
         Path object of the Python file.
-    additional_content : str
+    additional_content: str
         Additional content to add to the Python file.
-    str_before_def : str
+    str_before_def: str
         String before the function definition.
     """
 
@@ -177,7 +177,7 @@ def split_trail_alpha(text: str) -> Tuple[str, str]:
 
     Parameters
     ----------
-    text : str
+    text: str
         String to split.
     """
     for ii, char in enumerate(text):
@@ -195,7 +195,7 @@ def is_numeric(text: str) -> bool:
 
     Parameters
     ----------
-    text : str
+    text: str
         String to check.
 
     Returns
@@ -216,7 +216,7 @@ def get_refentry(filename: Path) -> list:
 
     Parameters
     ----------
-    filename : Path
+    filename: Path
         Path object of an XML file.
     """
     root = fromstring(open(filename, "rb").read())

src/pyconverter/xml2py/writer.py

@@ -59,7 +59,7 @@ def convert(directory_path):
 
     Parameters
     ----------
-    directory_path : Path
+    directory_path: Path
         Path to the directory containing the XML files to convert.
 
     Returns
@@ -84,7 +84,7 @@ def load_commands(
 
         Parameters
         ----------
-        xml_path : Path
+        xml_path: Path
             Path object of the directory containing the XML files to convert.
 
         Examples
@@ -159,7 +159,7 @@ def load_commands(
     name_map = create_name_map(meta_command, Path("config.yaml"))
     ast.NameMap(name_map)
 
-    # TODO : accept conversion of a single command
+    # TODO: accept conversion of a single command
 
     # convert a single command
     # if command is not None:
@@ -181,13 +181,13 @@ def copy_template_package(template_path: Path, new_package_path: Path, clean: bo
 
     Parameters
     ----------
-    template_path : Path
+    template_path: Path
         Path object containing the directory to copy.
 
-    new_package_path : Path
+    new_package_path: Path
         Path object containing the directory where the new files and directorys are to be added.
 
-    clean : bool, optional
+    clean: bool, optional
         Whether the directories in the path for the new package must be cleared before adding
         new files. The default value is ``False``.
 
@@ -219,7 +219,7 @@ def write_global__init__file(library_path: Path) -> None:
 
     Parameters
     ----------
-    library_path : Path
+    library_path: Path
         Path object of the directory containing the generated package.
     """
     mod_file = library_path / "__init__.py"
@@ -245,7 +245,7 @@ def write__init__file(library_path: Path) -> None:
 
     Parameters
     ----------
-    library_path : Path
+    library_path: Path
         Path object of the directory containing the generated package.
     """
 
@@ -273,9 +273,9 @@ def get_library_path(new_package_path: Path, config_path: Path) -> Path:
 
     Parameters
     ----------
-    new_package_path : Path
+    new_package_path: Path
         Path objecy of the new package directory.
-    config_path : str
+    config_path: str
         Path to the configuration file.
 
     Returns
@@ -296,9 +296,9 @@ def get_module_info(library_path: Path, command: ast.XMLCommand) -> Tuple[str, s
 
     Parameters
     ----------
-    library_path : Path
+    library_path: Path
         Path object to the library directory.
-    command : ast.XMLCommand
+    command: ast.XMLCommand
         Command object.
 
     Returns
@@ -323,9 +323,9 @@ def get_class_info(initial_class_name: str, module_path: Path) -> Tuple[str, str
 
     Parameters
     ----------
-    initial_class_name : str
+    initial_class_name: str
         Initial class name.
-    module_path : Path
+    module_path: Path
         Path object of the module directory.
 
     Returns
@@ -360,28 +360,28 @@ def write_source(
 
     Parameters
     ----------
-    command_map : dict
+    command_map: dict
         Dictionary with the following format: ``{"initial_command_name": command_obj}``.
-    name_map : dict
+    name_map: dict
         Dictionary with the following format: ``{"initial_command_name": "python_name"}``.
-    xml_doc_path : Path
+    xml_doc_path: Path
         Path object containing the XML directory to convert.
-    target_path : Path
+    target_path: Path
         Path object to generate the new package to.
-    path_custom_functions : Path, optional
+    path_custom_functions: Path, optional
         Path object containing the customized functions. The default value is ``None``.
-    template_path : Path, optional
+    template_path: Path, optional
         Path object of the template to use. If no path is provided, the default template is used.
-    config_path : Path, optional
+    config_path: Path, optional
         Path object of the configuration file. The default value is ``Path(config.yaml)``.`.
-    clean : bool, optional
+    clean: bool, optional
         Whether the directories in the new package path must be cleared before adding
         new files. The default value is ``True``.
-    structured : bool, optional
+    structured: bool, optional
         Whether the package should be structured. The default value is ``True``.
-    check_structure_map : bool, optional
+    check_structure_map: bool, optional
         Whether the structure map must be checked. The default value is ``False``.
-    check_files : bool, optional
+    check_files: bool, optional
         Whether the files must be checked. The default value is ``False``.
 
     Returns
@@ -518,12 +518,12 @@ def write_docs(
 
     Parameters
     ----------
-    package_path : Path
+    package_path: Path
         Path object of the new package folder.
-    package_structure : dict, optional
+    package_structure: dict, optional
         Dictionary with the following format:
         ``{'python_module_name': [{'python_class_name': python_names_list}]}``.
-    config_path : Path, optional
+    config_path: Path, optional
         Path object of the configuration file. The default value is ``Path(config.yaml)``.
 
     Returns