[FEATURE] Adding information only to the advanced help pages is now possible. #1652

smehringer · 2020-03-17T06:22:21Z

The following functions accept a seqan3::argument_parser::option_spec::ADVANCED to control what is displayed on the (advanced) help page:

seqan3::argument_parser::add_section
seqan3::argument_parser::add_subsection
seqan3::argument_parser::add_line
seqan3::argument_parser::add_list_item

Note that other seqan3::argument_parser::option_specs like REQUIRED are ignored.

joergi-w

Looks good! Just a few namespace issues, because we force seqan3:: prefix now, right?

test/unit/argument_parser/detail/format_help_test.cpp

joergi-w

Thank you!

codecov · 2020-03-17T08:32:09Z

Codecov Report

Merging #1652 into master will increase coverage by 0.01%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master    #1652      +/-   ##
==========================================
+ Coverage   97.66%   97.67%   +0.01%     
==========================================
  Files         236      237       +1     
  Lines        8988     9045      +57     
==========================================
+ Hits         8778     8835      +57     
  Misses        210      210

Impacted Files	Coverage Δ
include/seqan3/argument_parser/argument_parser.hpp	`98.54% <100.00%> (ø)`
...lude/seqan3/argument_parser/detail/format_base.hpp	`88.52% <100.00%> (-0.79%)`	⬇️
...ude/seqan3/argument_parser/detail/format_parse.hpp	`96.58% <100.00%> (ø)`
include/seqan3/io/sequence_file/input.hpp	`100.00% <0.00%> (ø)`
include/seqan3/io/alignment_file/input.hpp	`100.00% <0.00%> (ø)`
include/seqan3/io/sequence_file/output.hpp	`100.00% <0.00%> (ø)`
include/seqan3/io/structure_file/input.hpp	`100.00% <0.00%> (ø)`
include/seqan3/io/alignment_file/output.hpp	`100.00% <0.00%> (ø)`
include/seqan3/io/structure_file/output.hpp	`100.00% <0.00%> (ø)`
include/seqan3/search/algorithm/detail/search.hpp	`100.00% <0.00%> (ø)`
... and 6 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 372911c...3ca197e. Read the comment docs.

rrahn

In general looks good to me. Some small changes I'd like to suggest.

include/seqan3/argument_parser/argument_parser.hpp

include/seqan3/argument_parser/detail/format_base.hpp

test/unit/argument_parser/detail/format_help_test.cpp

rrahn

I have additional minor suggestions.

include/seqan3/argument_parser/detail/format_base.hpp

test/unit/argument_parser/detail/format_help_test.cpp

rrahn · 2020-03-19T16:54:12Z

something broke?

rrahn

looks fine. Some minor naming suggestions. And please have a look at the failing tests. Many thanks.

rrahn · 2020-03-19T16:57:47Z

include/seqan3/argument_parser/detail/format_base.hpp

-     * \param[in] spec The option specification.
-     * \returns `true` if the information annotated with `spec` should be added to the help page, `false` otherwise.
+    /*!\brief Adds a function object to parser_set_up_calls **if** the annotation in `spec` does not prevent it.
+     * \param[in] fun The function object that, if added to parser_set_up_calls, prints information to the help page.


Suggested change

* \param[in] fun The function object that, if added to parser_set_up_calls, prints information to the help page.

* \param[in] print_callback The invocable that, if added to `parser_set_up_calls`, prints information to the help page.

The name print_callback does not tell me much. I don't know what you are expressing by callback?
would printer be fine? :D

@rrahn ping

In computer programming, a callback, also known as a "call-after"[1] function, is any executable code that is passed as an argument to other code; that other code is expected to call back (execute) the argument at a given time.

So that's why callback tells me what it is. Since it is documented as invocable it would be fine for me to call it printer.

rrahn · 2020-03-24T08:54:28Z

Do you want me to squash or do you fix up the commit history?

smehringer · 2020-03-24T11:35:16Z

I cleaned the commit history

[DOC] Use \copydetails to avoid documentation duplication.

19843d4

smehringer requested review from a team and joergi-w and removed request for a team March 17, 2020 06:22

joergi-w requested changes Mar 17, 2020

View reviewed changes

test/unit/argument_parser/detail/format_help_test.cpp Outdated Show resolved Hide resolved

test/unit/argument_parser/detail/format_help_test.cpp Outdated Show resolved Hide resolved

test/unit/argument_parser/detail/format_help_test.cpp Outdated Show resolved Hide resolved

joergi-w requested changes Mar 17, 2020

View reviewed changes

test/unit/argument_parser/detail/format_help_test.cpp Outdated Show resolved Hide resolved

smehringer added this to ⏳ In Progress in Module: Argument Parser via automation Mar 17, 2020

joergi-w approved these changes Mar 17, 2020

View reviewed changes

smehringer force-pushed the argument_parser_misc branch from b2e8727 to f6a360d Compare March 17, 2020 08:32

smehringer requested a review from rrahn March 17, 2020 08:32

rrahn requested changes Mar 17, 2020

View reviewed changes

smehringer requested a review from rrahn March 18, 2020 09:21

rrahn requested changes Mar 18, 2020

View reviewed changes

include/seqan3/argument_parser/detail/format_base.hpp Outdated Show resolved Hide resolved

test/unit/argument_parser/detail/format_help_test.cpp Show resolved Hide resolved

smehringer requested a review from rrahn March 19, 2020 14:20

rrahn requested changes Mar 19, 2020

View reviewed changes

rrahn approved these changes Mar 24, 2020

View reviewed changes

smehringer added 2 commits March 24, 2020 12:34

[MISC] Add option spec variable for advanced help page information.

982cf42

[MISC] Remove reference when passing option_spec enum.

3ca197e

smehringer force-pushed the argument_parser_misc branch from da3ba62 to 3ca197e Compare March 24, 2020 11:35

smehringer merged commit d374879 into seqan:master Mar 25, 2020

Module: Argument Parser automation moved this from ⏳ In Progress to 🍻 Done Mar 25, 2020

smehringer deleted the argument_parser_misc branch May 29, 2020 05:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[FEATURE] Adding information only to the advanced help pages is now possible. #1652

[FEATURE] Adding information only to the advanced help pages is now possible. #1652

smehringer commented Mar 17, 2020

joergi-w left a comment

joergi-w left a comment

codecov bot commented Mar 17, 2020 •

edited

Loading

rrahn left a comment

rrahn left a comment

rrahn commented Mar 19, 2020

rrahn left a comment

rrahn Mar 19, 2020

smehringer Mar 19, 2020 •

edited

Loading

smehringer Mar 24, 2020

rrahn Mar 24, 2020

rrahn commented Mar 24, 2020

smehringer commented Mar 24, 2020

	* \param[in] fun The function object that, if added to parser_set_up_calls, prints information to the help page.
	* \param[in] print_callback The invocable that, if added to `parser_set_up_calls`, prints information to the help page.

[FEATURE] Adding information only to the advanced help pages is now possible. #1652

[FEATURE] Adding information only to the advanced help pages is now possible. #1652

Conversation

smehringer commented Mar 17, 2020

joergi-w left a comment

Choose a reason for hiding this comment

joergi-w left a comment

Choose a reason for hiding this comment

codecov bot commented Mar 17, 2020 • edited Loading

Codecov Report

rrahn left a comment

Choose a reason for hiding this comment

rrahn left a comment

Choose a reason for hiding this comment

rrahn commented Mar 19, 2020

rrahn left a comment

Choose a reason for hiding this comment

rrahn Mar 19, 2020

Choose a reason for hiding this comment

smehringer Mar 19, 2020 • edited Loading

Choose a reason for hiding this comment

smehringer Mar 24, 2020

Choose a reason for hiding this comment

rrahn Mar 24, 2020

Choose a reason for hiding this comment

rrahn commented Mar 24, 2020

smehringer commented Mar 24, 2020

codecov bot commented Mar 17, 2020 •

edited

Loading

smehringer Mar 19, 2020 •

edited

Loading