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.

Sign up for GitHub

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

Jump to bottom

Improve the documentation for the search module #30

Closed
10 tasks
rrahn opened this issue Mar 27, 2020 · 0 comments · Fixed by seqan/seqan3#1989
Closed
10 tasks

Improve the documentation for the search module #30

rrahn opened this issue Mar 27, 2020 · 0 comments · Fixed by seqan/seqan3#1989
Assignees
@joergi-w
Milestone
Sprint 7

Comments

@rrahn
Copy link
Contributor

rrahn commented Mar 27, 2020 •
edited

Description

The landing pages of the submodules should provide a detailed overview over the functionality contained in the module and how it is used with examples and proper visualisation.

Acceptance Criteria

  • user has all information about the search module available on the landing page of the module.

Tasks

  • update/refine the module landing page

Definition of Done

  • Implementation and design approved
  • Unit tests pass
  • Test coverage = 100%
  • Microbenchmarks added and/or affected microbenchmarks < 5% performance drop
  • API documentation added
  • Tutorial/teaching material added
  • Test suite compiles in less than 30 seconds (on travis)
  • Changelog entry added
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@joergi-w joergi-w

Labels
None yet
Projects
None yet
Milestone
Sprint 7
Development

Successfully merging a pull request may close this issue.

[DOC] Improve search documentation joergi-w/seqan3
2 participants
@rrahn @joergi-w