From e0bbc9b717c2d40148de392dcd6023cf17fb7a77 Mon Sep 17 00:00:00 2001
From: Jorge Marques <jorge.marques@analog.com>
Date: Tue, 24 Sep 2024 12:53:41 -0300
Subject: [PATCH] Rename typings to typing, bump version

To match Python nomenclature.
Minor version change since no-one is using the typing outside the pip
package.

Signed-off-by: Jorge Marques <jorge.marques@analog.com>
---
 adi_doctools/__init__.py                | 2 +-
 adi_doctools/cli/hdl_gen.py             | 2 +-
 adi_doctools/parser/hdl.py              | 6 +++---
 adi_doctools/{typings => typing}/hdl.py | 2 +-
 adi_doctools/writer/hdl.py              | 6 +++---
 tests/test_hdl_interfaces.py            | 2 +-
 6 files changed, 10 insertions(+), 10 deletions(-)
 rename adi_doctools/{typings => typing}/hdl.py (96%)

diff --git a/adi_doctools/__init__.py b/adi_doctools/__init__.py
index f84c350..afdf719 100644
--- a/adi_doctools/__init__.py
+++ b/adi_doctools/__init__.py
@@ -12,7 +12,7 @@
 from .lut import get_lut
 from .role.interref import interref_repos_apply
 
-__version__ = "0.3.44"
+__version__ = "0.3.45"
 
 logger = logging.getLogger(__name__)
 
diff --git a/adi_doctools/cli/hdl_gen.py b/adi_doctools/cli/hdl_gen.py
index 9765683..24ab136 100644
--- a/adi_doctools/cli/hdl_gen.py
+++ b/adi_doctools/cli/hdl_gen.py
@@ -6,7 +6,7 @@
 from os import path, walk, pardir, chdir, getcwd
 from glob import glob
 
-from ..typings.hdl import vendors, Library, Carrier, Project
+from ..typing.hdl import vendors, Library, Carrier, Project
 from ..parser.hdl import parse_hdl_regmap
 from ..parser.hdl import resolve_hdl_regmap
 from ..parser.hdl import expand_hdl_regmap
diff --git a/adi_doctools/parser/hdl.py b/adi_doctools/parser/hdl.py
index 9cd77c5..3f0fbcf 100644
--- a/adi_doctools/parser/hdl.py
+++ b/adi_doctools/parser/hdl.py
@@ -6,9 +6,9 @@
 from lxml import etree
 from os import path
 
-from ..typings.hdl import Intf, IntfPort
-from ..typings.hdl import Library, LibraryVendor
-from ..typings.hdl import Project
+from ..typing.hdl import Intf, IntfPort
+from ..typing.hdl import Library, LibraryVendor
+from ..typing.hdl import Project
 from ..directive.string import string_hdl
 from .tcl import tcl
 
diff --git a/adi_doctools/typings/hdl.py b/adi_doctools/typing/hdl.py
similarity index 96%
rename from adi_doctools/typings/hdl.py
rename to adi_doctools/typing/hdl.py
index 2bb9a20..82eda1d 100644
--- a/adi_doctools/typings/hdl.py
+++ b/adi_doctools/typing/hdl.py
@@ -47,7 +47,7 @@ class Carrier(TypedDict):
 class Project(TypedDict):
     """
     __key__: some_project/carrier, some_project
-    name: some_project_carrier
+    name: some_project_carrier, some_project
     lib_deps: my_ip, framework/framework_core
     m_deps: some_constr.xdc
     """
diff --git a/adi_doctools/writer/hdl.py b/adi_doctools/writer/hdl.py
index 0b81c1b..a626e0e 100644
--- a/adi_doctools/writer/hdl.py
+++ b/adi_doctools/writer/hdl.py
@@ -4,7 +4,7 @@
 from os import path
 
 from ..__init__ import __version__
-from ..typings.hdl import vendors, Library, Project
+from ..typing.hdl import vendors, Library, Project
 
 svpkg_fn_new0 = """
       function new(
@@ -213,7 +213,7 @@ def write_hdl_regmap(
 def write_hdl_library_makefile(
     libraries: Dict[str, Library],
     path_: str
-) -> Tuple[str]:
+) -> None:
     library = libraries[path_]
     fname = "Makefile"
     file = path.join('library', path_, fname)
@@ -256,7 +256,7 @@ def write_hdl_library_makefile(
 def write_hdl_project_makefile(
     project: Dict[str, Project],
     path_: str
-) -> Tuple[str]:
+) -> None:
     project = project[path_]
     fname = "Makefile"
     file = path.join('projects', path_, fname)
diff --git a/tests/test_hdl_interfaces.py b/tests/test_hdl_interfaces.py
index 54fa9eb..6a5d994 100644
--- a/tests/test_hdl_interfaces.py
+++ b/tests/test_hdl_interfaces.py
@@ -1,7 +1,7 @@
 from os import path
 
 from adi_doctools.parser.hdl import parse_hdl_interfaces
-from adi_doctools.typings.hdl import Intf
+from adi_doctools.typing.hdl import Intf
 
 intf_0 = Intf(
     description=None,