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

Improve documentation for interpolate function #194

Open
natema opened this issue Apr 22, 2023 · 0 comments
Open

Improve documentation for interpolate function #194

natema opened this issue Apr 22, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@natema
Copy link
Member

natema commented Apr 22, 2023

The docstring of interpolate currently cite a non-existent fourth argument ("an increment value").
This should be fixed, and the docstring should be expanded to include a clear explanation of what the function is doing.
At the end, it should also cite the DYNAMO manual for reference:

A. L. Pugh, DYNAMO user’s manual. 1963. Accessed: Jun. 02, 2022. Available: http://archive.org/details/dynamousersmanua00pugh

For convenience, I'm copy-pasting the screenshot of the pages of the manual that refer to it.
image
image

@natema natema added documentation Improvements or additions to documentation good first issue Good for newcomers labels Apr 22, 2023
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 good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant