Improve data-structures/heap/README.md #94
Merged
Conversation
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
The overuse of parenthesis in the previous description made the explanation of a heap more diffcult to read. Following technical writing standards, the topic of the sentence should be at the forefront of a sentence, to give the reader an idea of what is going to be explained in said sentence. The mention of min heap and max heap were previously in parenthesis, in the middle of the sentence. This change informs the reader that there are two types of heaps, with a preface indicating which one is being explained.
Add a picture of a min heap below the explanation of a min heap. Move the picture of a max heap below the explanation of a max heap.
Italicize the terms 'max heap' and 'min heap' to make it clear to readers that new terminology is being introduced
Codecov Report
@@ Coverage Diff @@
## master #94 +/- ##
=====================================
Coverage 100% 100%
=====================================
Files 105 105
Lines 2121 2121
Branches 367 367
=====================================
Hits 2121 2121Continue to review full report at Codecov.
|
|
@CorreyL thank you for your edits and for additional picture of min-heap. And good luck with university assignment! :) |
shoredata
pushed a commit
to shoredata/javascript-algorithms
that referenced
this pull request
Mar 28, 2019
* Update data-structure/heap/README.md The overuse of parenthesis in the previous description made the explanation of a heap more diffcult to read. Following technical writing standards, the topic of the sentence should be at the forefront of a sentence, to give the reader an idea of what is going to be explained in said sentence. The mention of min heap and max heap were previously in parenthesis, in the middle of the sentence. This change informs the reader that there are two types of heaps, with a preface indicating which one is being explained. * Add min heap picture and move max heap picture Add a picture of a min heap below the explanation of a min heap. Move the picture of a max heap below the explanation of a max heap. * Italicize heap terminology Italicize the terms 'max heap' and 'min heap' to make it clear to readers that new terminology is being introduced
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.
Aspects of the
src/data-structures/heap/README.mdfile could be made easier to understand with the edits I have made.Additionally, I've added a picture of a min heap to distinguish from the only picture in the previous revision, which only displayed a max heap.
In the interest of full transparency, this is for a university assignment that requires us to make edits to technical documentation. Approvals will result in a higher grade.