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

Add unit test and documentation for get_mi_coord and get_mi_vector #3697

Closed
fweik opened this issue Apr 30, 2020 · 3 comments · Fixed by #3747
Closed

Add unit test and documentation for get_mi_coord and get_mi_vector #3697

fweik opened this issue Apr 30, 2020 · 3 comments · Fixed by #3747
Assignees
@jngrad
Labels
Core Documentation

Comments

@fweik
Copy link
Contributor

fweik commented Apr 30, 2020 •
edited
Loading

We should tests for those important functions. Also they are not documented.
@fweik
Copy link
Contributor Author

fweik commented Apr 30, 2020

It might also be possible that there are better names for those functions.

@jngrad
Copy link
Member

jngrad commented Jun 2, 2020

The docs are indeed missing, but there are some basic test cases in src/core/unit_tests/grid_test.cpp. Do you have a more specific test scenario in mind?

@fweik
Copy link
Contributor Author

fweik commented Jun 2, 2020

Apparently I missed those, they seem fine.

@fweik fweik removed the Testcase label Jun 2, 2020
@jngrad jngrad self-assigned this Jun 2, 2020
@jngrad jngrad mentioned this issue Jun 3, 2020
Merged
@kodiakhq kodiakhq bot closed this as completed in #3747 Jun 5, 2020
kodiakhq bot added a commit that referenced this issue Jun 5, 2020
@kodiakhq
Document BoxGeometry-related functions (#3747)
6d509f7 
Fixes #3697

Description of changes:
- document `get_mi_coord()`, `get_mi_vector()` and related functions
- add unit test for `fold_position()`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jngrad jngrad

Labels
Core Documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Document BoxGeometry-related functions jngrad/espresso
2 participants
@fweik @jngrad