ansys / pyedb-core

Ansys Electronics Database Python Client Package
https://edb.core.docs.pyansys.com/
MIT License
2 stars 1 forks source link

PadstackInstanceTerminal.create() docstring wrong #373

Open svandenb-dev opened 5 months ago

svandenb-dev commented 5 months ago

Description of the modifications

pyedb code:

def create(self, padstack_instance, name=None, layer=None, is_ref=False):
    """Create an edge terminal.

    Parameters
    ----------
    prim_id : int
        Primitive ID.
    point_on_edge : list
        Coordinate of the point to define the edge terminal.
        The point must be on the target edge but not on the two
        ends of the edge.
    terminal_name : str, optional
        Name of the terminal. The default is ``None``, in which case the
        default name is assigned.
    is_ref : bool, optional
        Whether it is a reference terminal. The default is ``False``.
    Returns
    -------
    Edb.Cell.Terminal.EdgeTerminal

online doc

image

Useful links and references

No response

hiro727 commented 5 months ago

@svandenb-dev your pyedb code shows EdgeTerminal whereas the doc shows PadstackInstanceTerminal. doc for each method seems correct. can you clarify?

svandenb-dev commented 5 months ago

@hiro727 I will check again maybe this was a mistake