aboutsummaryrefslogtreecommitdiffstats
path: root/pyGHDL/libghdl/__init__.py
diff options
context:
space:
mode:
authorPatrick Lehmann <Patrick.Lehmann@plc2.de>2021-01-04 15:19:37 +0100
committertgingold <tgingold@users.noreply.github.com>2021-01-05 18:50:44 +0100
commitef5f93a9d726c7c68899beb276c0b7f3f446c196 (patch)
treeef90a9270c7f75ea854a3820fcc087e2dae88f06 /pyGHDL/libghdl/__init__.py
parente60be77e4f3cbccf67761a3c169799ff59b7086f (diff)
downloadghdl-ef5f93a9d726c7c68899beb276c0b7f3f446c196.tar.gz
ghdl-ef5f93a9d726c7c68899beb276c0b7f3f446c196.tar.bz2
ghdl-ef5f93a9d726c7c68899beb276c0b7f3f446c196.zip
Fixed parameter reference.
Diffstat (limited to 'pyGHDL/libghdl/__init__.py')
-rw-r--r--pyGHDL/libghdl/__init__.py6
1 files changed, 3 insertions, 3 deletions
diff --git a/pyGHDL/libghdl/__init__.py b/pyGHDL/libghdl/__init__.py
index 1f24ab631..2d7791b51 100644
--- a/pyGHDL/libghdl/__init__.py
+++ b/pyGHDL/libghdl/__init__.py
@@ -56,7 +56,7 @@ def _get_libghdl_name() -> Path:
def _check_libghdl_libdir(libdir: Path, basename: Path) -> Path:
- """Returns libghdl path in :param:`libdir`, if found."""
+ """Returns libghdl path in :obj:`libdir`, if found."""
if libdir is None:
raise ValueError("Parameter 'libdir' is None.")
# print('libghdl: check in {}'.format(libdir))
@@ -160,7 +160,7 @@ def initialize() -> None:
@export
def set_option(opt: bytes) -> bool:
- """Set option :param:`opt`. Return true, if the option is known and handled."""
+ """Set option :obj:`opt`. Return true, if the option is known and handled."""
return libghdl.libghdl__set_option(*_to_char_p(opt)) == 0
@@ -181,7 +181,7 @@ def analyze_init_status() -> int:
@export
def analyze_file(fname: bytes):
- """"Analyze a given filename :param:`fname`."""
+ """"Analyze a given filename :obj:`fname`."""
return libghdl.libghdl__analyze_file(*_to_char_p(fname))