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.

Sign up for GitHub

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

Jump to bottom

Docstring of distancevector is unclear #33

Closed
mastrof opened this issue May 7, 2023 · 0 comments · Fixed by #41
Closed

Docstring of distancevector is unclear #33

mastrof opened this issue May 7, 2023 · 0 comments · Fixed by #41
Labels
documentation Improvements or additions to documentation

Comments

@mastrof
Copy link
Owner

mastrof commented May 7, 2023

The docstring does not explain if the vector is calculated from a to b or viceversa.
The new docstring should read

Evaluate the distance vector from a to b respecting the spatial properties of model.
@mastrof mastrof added the documentation Improvements or additions to documentation label May 7, 2023
@mastrof mastrof mentioned this issue May 8, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix docstrings of distance and distancevector mastrof/MicrobeAgents.jl
1 participant
@mastrof