Skip to content

Improve data-structures/heap/README.md #94

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.

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

Merged
merged 3 commits into from
Jul 8, 2018
Merged

Conversation

CorreyL
Copy link
Contributor

@CorreyL CorreyL commented Jul 7, 2018

Aspects of the src/data-structures/heap/README.md file 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.

CorreyL added 3 commits July 7, 2018 12:48
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-io
Copy link

Codecov Report

Merging #94 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@          Coverage Diff          @@
##           master    #94   +/-   ##
=====================================
  Coverage     100%   100%           
=====================================
  Files         105    105           
  Lines        2121   2121           
  Branches      367    367           
=====================================
  Hits         2121   2121

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 b878390...513a302. Read the comment docs.

@trekhleb
Copy link
Owner

trekhleb commented Jul 8, 2018

@CorreyL thank you for your edits and for additional picture of min-heap. And good luck with university assignment! :)

@trekhleb trekhleb merged commit a3d0990 into trekhleb:master Jul 8, 2018
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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants