Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add more examples in the docstrings #31

Open
franaudo opened this issue Oct 17, 2020 · 0 comments
Open

add more examples in the docstrings #31

franaudo opened this issue Oct 17, 2020 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@franaudo
Copy link
Contributor

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)
    """
@franaudo franaudo added the documentation Improvements or additions to documentation label Oct 17, 2020
@franaudo franaudo self-assigned this Oct 17, 2020
@franaudo franaudo added this to the Release inside NCCR milestone Oct 17, 2020
@tomvanmele tomvanmele removed this from the Release inside NCCR milestone Jan 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants