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

SplineBuilder doc #409

Merged
merged 117 commits into from
Jun 7, 2024
Merged

SplineBuilder doc #409

merged 117 commits into from
Jun 7, 2024

Conversation

blegouix
Copy link
Collaborator

No description provided.

@blegouix blegouix marked this pull request as draft April 16, 2024 13:41
@blegouix blegouix self-assigned this Apr 16, 2024
@blegouix blegouix changed the base branch from main to clarify-spline-names April 16, 2024 13:45
EmilyBourne
EmilyBourne previously approved these changes May 6, 2024
Copy link
Collaborator

@EmilyBourne EmilyBourne left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good work. Thanks for making all the changes

@EmilyBourne EmilyBourne added the documentation Improvements or additions to documentation label May 6, 2024
EmilyBourne
EmilyBourne previously approved these changes May 16, 2024
include/ddc/kernels/splines/spline_builder.hpp Outdated Show resolved Hide resolved
include/ddc/kernels/splines/spline_builder.hpp Outdated Show resolved Hide resolved
* @param x The SplineBuilder being copied.
* @returns A reference to this object.
* @param x An rvalue to another SplineBuilder.
* @return A reference to the moved SplineBuilder
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't it x that is "moved" ?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to the SplineBuilder once moved ?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tpadioleau I think this is the last remaining comment here, to me something can be qualified as "moved" only once it has been moved, and only the moved thing not the remaining empty place where it comes from. But this is a bit too philisophical to me so please suggest something if you don't agree ^^

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would keep the original doc on the return section. The reference is really on the object *this, not the object that has been moved, x.

include/ddc/kernels/splines/spline_builder.hpp Outdated Show resolved Hide resolved
include/ddc/kernels/splines/spline_builder_2d.hpp Outdated Show resolved Hide resolved
include/ddc/kernels/splines/spline_builder_2d.hpp Outdated Show resolved Hide resolved
include/ddc/kernels/splines/spline_builder_2d.hpp Outdated Show resolved Hide resolved
* The temporary SplineBuilder2D being copied.
* @returns A reference to this object.
* @param x An rvalue to another SplineBuilder.
* @return A reference to the moved SplineBuilder
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same problem here

include/ddc/kernels/splines/spline_builder_2d.hpp Outdated Show resolved Hide resolved
Co-authored-by: Thomas Padioleau <[email protected]>
@blegouix blegouix mentioned this pull request Jun 5, 2024
include/ddc/kernels/splines/spline_builder.hpp Outdated Show resolved Hide resolved
include/ddc/kernels/splines/spline_builder_2d.hpp Outdated Show resolved Hide resolved
@tpadioleau tpadioleau merged commit f7ebfb6 into main Jun 7, 2024
3 of 9 checks passed
@tpadioleau tpadioleau deleted the splines-doc branch June 7, 2024 07:39
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants