compas-dev / compas-dev/compas_fea2
add more examples in the docstrings
- Dominant language
- Python
- Stars
- 14
- Forks
- 10
- PR merge metrics
- No merged PRs in 30d
Description
Include simple implementation examples directly in the doc strings, like:
```
Parameters
----------
xyz : list
[x, y, z] co-ordinates of the node.
x : float
x co-ordinates of the node.
y : float
y co-ordinates of the node.
z : float
z co-ordinates of the node.
ex : list
Node's local x axis.
ey : list
Node's local y axis.
ez : list
Node's local z axis.
mass : float
Mass in kg associated with the node.
label : string
Node's label. If no label is specified, it is automatically generated
when a node is added. The label does not need to be unique.
key : int
Node key number. The key number is unique.
Examples
--------
>>> node = Node(1.0, 2.0, 3.0)
"""
```
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.