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 "Parameters" and "Returns" to all functions #5

Open
hagenw opened this issue Jan 12, 2016 · 0 comments
Open

Add "Parameters" and "Returns" to all functions #5

hagenw opened this issue Jan 12, 2016 · 0 comments
Labels

Comments

@hagenw
Copy link
Member

hagenw commented Jan 12, 2016

Reviewing the source models in sfs/mono/source.py I realized that some of them have documentation explaining the input and output parameters using

Parameters
----------
omega : float
    Frequency of source.
x0 : (3,) array_like
    Position of source.

Returns
-------
XyzComponents
    Particle velocity at positions given by `grid`.
    See :class:`sfs.util.XyzComponents`.

Maybe it is a good idea to add this to all functions as it helps a new user a lot, while reading the API.

I can help to add this to the existing ones. This issue is more about that we should start to add this to all new functions we are going to implement.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants