Skip to content

Commit

Permalink
Replaced :py: by :.
Browse files Browse the repository at this point in the history
  • Loading branch information
Paebbels committed May 21, 2023
1 parent 19d38ab commit 98d9f5c
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
8 changes: 4 additions & 4 deletions pyVHDLModel/DesignUnit.py
Expand Up @@ -170,7 +170,7 @@ def Library(self, library: 'Library') -> None:
def ContextItems(self) -> List['ContextUnion']:
"""
Read-only property to access the sequence of all context items comprising library, use and context clauses
(:py:attr:`_contextItems`).
(:attr:`_contextItems`).
:returns: Sequence of context items.
"""
Expand All @@ -179,7 +179,7 @@ def ContextItems(self) -> List['ContextUnion']:
@property
def ContextReferences(self) -> List['ContextReference']:
"""
Read-only property to access the sequence of context clauses (:py:attr:`_contextReferences`).
Read-only property to access the sequence of context clauses (:attr:`_contextReferences`).
:returns: Sequence of context clauses.
"""
Expand All @@ -188,7 +188,7 @@ def ContextReferences(self) -> List['ContextReference']:
@property
def LibraryReferences(self) -> List['LibraryClause']:
"""
Read-only property to access the sequence of library clauses (:py:attr:`_libraryReferences`).
Read-only property to access the sequence of library clauses (:attr:`_libraryReferences`).
:returns: Sequence of library clauses.
"""
Expand All @@ -197,7 +197,7 @@ def LibraryReferences(self) -> List['LibraryClause']:
@property
def PackageReferences(self) -> List['UseClause']:
"""
Read-only property to access the sequence of use clauses (:py:attr:`_packageReferences`).
Read-only property to access the sequence of use clauses (:attr:`_packageReferences`).
:returns: Sequence of use clauses.
"""
Expand Down
10 changes: 5 additions & 5 deletions pyVHDLModel/Name.py
Expand Up @@ -33,7 +33,7 @@
This module contains parts of an abstract document language model for VHDL.
VHDL uses *names* to express cross-references from *usage locations* to *declarations*. Here, *names* are single or
combined identifiers. :py:mod:`Symbols <pyVHDLModel.Symbol>` are structures representing a *name* and a reference
combined identifiers. :mod:`Symbols <pyVHDLModel.Symbol>` are structures representing a *name* and a reference
(pointer) to the referenced vhdl language entity.
"""
from typing import List, Iterable, Optional as Nullable
Expand Down Expand Up @@ -88,7 +88,7 @@ def Root(self) -> 'Name':
"""
The root (left-most) element in a chain of names.
In case the name is a :py:class:`simple name <SimpleName>`, the root points to the name itself.
In case the name is a :class:`simple name <SimpleName>`, the root points to the name itself.
:returns: The name's root element.
"""
Expand All @@ -108,7 +108,7 @@ def HasPrefix(self) -> bool:
"""
Returns true, if the name has a prefix.
This is true for all names except :py:class:`simple names <SimpleName>`.
This is true for all names except :class:`simple names <SimpleName>`.
:returns: ``True``, if the name as a prefix.
"""
Expand Down Expand Up @@ -183,8 +183,8 @@ class SelectedName(Name):
A *selected name* is a name made from multiple words separated by a dot (``.``).
For example, the library and entity name in a direct entity instantiation is a selected name. Here the entity
identifier is a selected name. The library identifier is a :py:class:`simple name <SimpleName>`, which is
referenced by the selected name via the :py:attr:`~pyVDLModel.Name.Prefix` property.
identifier is a selected name. The library identifier is a :class:`simple name <SimpleName>`, which is
referenced by the selected name via the :attr:`~pyVHDLModel.Name.Prefix` property.
"""

def __init__(self, identifier: str, prefix: Name):
Expand Down

0 comments on commit 98d9f5c

Please sign in to comment.