Repository navigation
Rewrite the 6.0.0 CHANGELOG for people upgrading - #1938
Merged
Merged
Conversation
The 6.0.0 section had grown to about 15,000 words in the order the work was done. It is now about a third as long and grouped for a reader upgrading from 5.x: headlines; what to change when upgrading, by area; output that differs from 5.x, for anyone comparing files with ones 5.x wrote; new features; deprecations; performance against 5.0.2; and bug fixes by area, one line each, with issue links for the detail. The build and testing notes are dropped. Entries are added for user-visible changes the section missed (DiskBackedQueue no longer cleans up on garbage collection, Java serialization of 5.x VCF objects, the BCF writer refusing a custom IndexCreator, SAMUtils overlap clipping, several CRAM fixes, faster SAM parsing, the runtime dependency updates), and entries describing fixes of bugs no release had are removed.
|
Important Review skippedReview was skipped as selected files did not have any reviewable changes.
|
…ipped SAM Each headline now links to its section. Indexing leads with a table of the index each format writes and reads, then a few short bullets and two paragraphs; VCF and BCF versions lead with a table of what is read and written; bgzipped SAM has its own short section. Index-related upgrade notes are gathered under one heading, and the longer upgrade bullets are shortened.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Rewrites the 6.0.0 CHANGELOG section for people upgrading from 5.x: under a third as long (15,300 → 4,300 words), grouped by what a reader needs rather than by the order the work was done.
DiskBackedQueueno longer cleans up on garbage collection.IndexCreator.