Fix docstring errors and operator+ signature in TensorCommon. Fixes gyselax #562#563
Merged
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
EmilyBourne
approved these changes
Mar 1, 2026
EmilyBourne
reviewed
Mar 1, 2026
Co-authored-by: Emily Bourne <louise.bourne@gmail.com>
EmilyBourne
added a commit
that referenced
this pull request
Mar 5, 2026
…yselax #562 (#563) Fix docstring errors and operator+ signature in TensorCommon. Fixes #562 Several bugs found in `src/data_types/tensor_common.hpp` : **Code bug ** - `operator+` for tensor addition uses `Oelement_type` (scalar type) instead of `TensorType` , for the `operator+` 2nd parameter , inconsistent with `operator-` . //Current template <..> TensorType operator+(TensorType const& tensor, Oelement_type val) //should match operator- template<..> TensorType operator+(TensorType const& tensor, TensorType const& val) **Docstring Bugs:** - `operator/=` : says "multiplied " instead of divided; - `operator-` (Coord): brief says "add" instead of "subtract" - `operator -=`(Coord) : brief says "add" instead of "subtract" - `operator/` : says "multiplied/ multiplication" instead of "divided/division" - `operator*` (first): says "multiply all a tensor" instead of "multiply all elements of a tensor" - Move constructor: says "copying" instead of "moving" - Move assign: says "copied" instead of "moved" --------- Co-authored-by: Emily Bourne <emily.bourne@epfl.ch>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fix docstring errors and operator+ signature in TensorCommon. Fixes #562
Several bugs found in
src/data_types/tensor_common.hpp:**Code bug **
operator+for tensor addition usesOelement_type(scalar type) instead ofTensorType, for theoperator+2nd parameter , inconsistent withoperator-.//Current
template <..>
TensorType operator+(TensorType const& tensor, Oelement_type val)
//should match operator-
template<..>
TensorType operator+(TensorType const& tensor, TensorType const& val)
Docstring Bugs:
operator/=: says "multiplied " instead of divided;operator-(Coord): brief says "add" instead of "subtract"operator -=(Coord) : brief says "add" instead of "subtract"operator/: says "multiplied/ multiplication" instead of "divided/division"operator*(first): says "multiply all a tensor" instead of "multiply all elements of a tensor"Please complete the checklist to ensure that all tasks are completed before marking your pull request as ready for review.
All Submissions
New Feature Submissions
Changes to Existing Features
Changes to the CI