Better docs for cell
, charges
, positions
#160
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The shapes and the contents of these parameters are not clear in the current version. Now we (hopefully) use the same docstring for all of these.
I also used lower cases for
torch.tensor
in the docstring to be consistent with other types likelist
,dict
, etc.For a review it is enough to check if these lines are okay
and a slightly shorter version for the charges in some modules.
Contributor (creator of pull-request) checklist
Reviewer checklist
📚 Documentation preview 📚: https://torch-pme--160.org.readthedocs.build/en/160/