BioAlignments.jl icon indicating copy to clipboard operation
BioAlignments.jl copied to clipboard

Update the alignment figure

Open alyst opened this issue 2 years ago • 1 comments

Update the alignment figure in the documentation

This template is rather extensive. Fill out all that you can, if are a new contributor or you're unsure about any section, leave it unchanged and a reviewer will help you :smile:. This template is simply a tool to help everyone remember the BioJulia guidelines, if you feel anything in this template is not relevant, simply delete it.

Types of changes

This PR implements the following changes: (Please tick any or all of the following that are applicable)

  • [ ] :sparkles: New feature (A non-breaking change which adds functionality).
  • [ ] :bug: Bug fix (A non-breaking change, which fixes an issue).
  • [ ] :boom: Breaking change (fix or feature that would cause existing functionality to change).

:clipboard: Additional detail

As a follow-up to #61, I have updated the figure. Now it combines both the pairwise alignment (which before was a verbatim text) and sequence of anchors (before it was Julia code, now it's a table in a SVG file). I think it makes the idea of the anchors more clear.

  • If you have implemented new features or behaviour

    • Provide a description of the addition in as many details as possible.

    • Provide justification of the addition.

    • Provide a runnable example of use of your addition. This lets reviewers and others try out the feature before it is merged or makes it's way to release.

  • If you have changed current behaviour...

    • Describe the behaviour prior to you changes

    • Describe the behaviour after your changes and justify why you have made the changes, Please describe any breakages you anticipate as a result of these changes.

    • Does your change alter APIs or existing exposed methods/types? If so, this may cause dependency issues and breakages, so the maintainer will need to consider this when versioning the next release.

    • If you are implementing changes that are intended to increase performance, you should provide the results of a simple performance benchmark exercise demonstrating the improvement. Especially if the changes make code less legible.

:ballot_box_with_check: Checklist

  • [ ] :art: The changes implemented is consistent with the julia style guide.
  • [ ] :blue_book: I have updated and added relevant docstrings, in a manner consistent with the documentation styleguide.
  • [x] :blue_book: I have added or updated relevant user and developer manuals/documentation in docs/src/.
  • [ ] :ok: There are unit tests that cover the code changes I have made.
  • [ ] :ok: The unit tests cover my code changes AND they pass.
  • [ ] :pencil: I have added an entry to the [UNRELEASED] section of the manually curated CHANGELOG.md file for this repository.
  • [ ] :ok: All changes should be compatible with the latest stable version of Julia.
  • [ ] :thought_balloon: I have commented liberally for any complex pieces of internal code.

alyst avatar Nov 25 '21 15:11 alyst

Codecov Report

Merging #62 (2d3be18) into master (ed08737) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##           master      #62   +/-   ##
=======================================
  Coverage   87.95%   87.95%           
=======================================
  Files          16       16           
  Lines        1121     1121           
=======================================
  Hits          986      986           
  Misses        135      135           

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 ed08737...2d3be18. Read the comment docs.

codecov[bot] avatar Nov 25 '21 15:11 codecov[bot]