-
Notifications
You must be signed in to change notification settings - Fork 82
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
[Alignment Configuration] Rename align_cfg::alignment_result_capture to align_cfg::detail::result_type #2031
[Alignment Configuration] Rename align_cfg::alignment_result_capture to align_cfg::detail::result_type #2031
Conversation
ba6e6d5
to
a9dff81
Compare
0717a10
to
22167f8
Compare
include/seqan3/alignment/configuration/align_config_result_type.hpp
Outdated
Show resolved
Hide resolved
@@ -34,6 +32,7 @@ enum struct align_config_id : uint8_t | |||
on_result, //!< ID for the \ref seqan3::align_cfg::on_result "on_result" option. | |||
parallel, //!< ID for the \ref seqan3::align_cfg::parallel "parallel" option. | |||
result, //!< ID for the \ref seqan3::align_cfg::result "result" option. | |||
result_type, //!\brief ID for the \ref seqan3::align_cfg::detail::result_type "result_type" option. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is different from the other lines... I don't know what's the impact, but please consider to keep the existing style.
result_type, //!\brief ID for the \ref seqan3::align_cfg::detail::result_type "result_type" option. | |
result_type, //!< ID for the \ref seqan3::align_cfg::detail::result_type "result_type" option. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Attention: Here is detail
code documentation in the user visible documentation!
@ second reviewer: Is it fine or should we avoid this? (how?)
Merging this PR closes #2018 because it has the same intention. |
22167f8
to
4aad14d
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, just a small documentation error is left. I assign the second reviewer now.
At the end I will have a final sweep to check for consistency issues that might happen between the PRs. I already had one config on the align_cfg::detail namespace and adapted only the things locally and wanted to add the namespace at the end. I am wondering why this was now exposed to all configs? Anyhow, now it is done already. We should wait for this change (already approved) and then rebase all the configs on top of this. |
@simonsasse I am waiting on the rebase on #2020 before I review. So I can focus on the actual changes. |
4aad14d
to
66f3f01
Compare
Codecov Report
@@ Coverage Diff @@
## release-3.0.2 #2031 +/- ##
==============================================
Coverage 97.91% 97.91%
==============================================
Files 263 263
Lines 9887 9887
==============================================
Hits 9681 9681
Misses 206 206
Continue to review full report at Codecov.
|
include/seqan3/alignment/configuration/align_config_result_type.hpp
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some general renaming, otherwise looks very good. Thank you
include/seqan3/alignment/configuration/align_config_result_type.hpp
Outdated
Show resolved
Hide resolved
include/seqan3/alignment/configuration/align_config_result_type.hpp
Outdated
Show resolved
Hide resolved
380538f
to
8cb5d28
Compare
Thanks for the review @rrahn . I applied all the changes and also rebased on the latest version of the release branch because there where merge conflicts. On my machine tests pass 💻✅ |
…to align_cfg::detail::result_type
8cb5d28
to
1efd0ca
Compare
include/seqan3/alignment/configuration/align_config_vectorised.hpp
Outdated
Show resolved
Hide resolved
whats the state here? |
If @marehr review counts as second review, its time for a merge I think :) |
@marehr anything to add? Otherwise I'll merge (or you if you see this). |
I only waited on CI and forgot that I waited in CI 🙈 (I'm not accustomed to be second reviewer) xD |
Resolves seqan/product_backlog#183
This moves the alignment_result_capture to a new namespace seqan3::align_cfg::detail and then renames it to result_type.
I needed to specify the whole namespace path seqan3::detail::XX for most of the view files. This is due to the newly created seqan3::align_cfg::detail which had a name clash with seqan3::detail.
Merging this PR closes #2018 because it has the same intention.
Blocked by #2033