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.

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

Additional intro blockchain doc #7974

Merged
merged 9 commits into from
Nov 15, 2022

Conversation

GK3077
Copy link
Contributor

@GK3077 GK3077 commented Nov 6, 2022

With respect to Blockchain File

Describe your change:

  • Add an algorithm?
  • Fix a bug or typo in an existing algorithm?
  • Documentation change?

Checklist:

  • I have read CONTRIBUTING.md.
  • This pull request is all my own work -- I have not plagiarized.
  • I know that pull requests will not be merged if they fail the automated tests.
  • This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms.
  • All new Python files are placed inside an existing directory.
  • All filenames are in all lowercase characters with no spaces or dashes.
  • All functions and variable names follow Python naming conventions.
  • All function parameters and return values are annotated with Python type hints.
  • All functions have doctests that pass the automated testing.
  • All new algorithms include at least one URL that points to Wikipedia or another similar explanation.
  • If this pull request resolves one or more open issues then the commit message contains Fixes: #{6642}.

Rectified errors as image was not visible
Deleting the image as it is not getting accepted in PR merge
Deleting the image as it is not getting accepted in PR merge
Removed all image s in the document
@algorithms-keeper algorithms-keeper bot added awaiting reviews This PR is ready to be reviewed documentation This PR modified documentation files labels Nov 6, 2022
@GK3077 GK3077 mentioned this pull request Nov 6, 2022
14 tasks
Copy link
Contributor

@CaedenPH CaedenPH left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A lot of the sentences you have written don't make grammatical sense. Please review your sentences and fix any grammatical/punctuational mistakes.

If you need any help don't hesitate to ask


Let's breakdown the terminologies in the above definition. We find below terminologies,

- Digital Ledger Technology(DLT)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Digital Ledger Technology(DLT)
- Digital Ledger Technology (DLT)


It is otherwise called as distributed ledger technology. It is simply the opposite of centralized database. Firstly, what is a **ledger**? A ledger is a book or collection of accounts that records account transactions.

*Then why is Blockchain addressed as digital ledger when it can record more than account transactions?* *And what are other transactions and details it can hold?*
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
*Then why is Blockchain addressed as digital ledger when it can record more than account transactions?* *And what are other transactions and details it can hold?*
*Then why is Blockchain addressed as digital ledger when it can record more than account transactions? And what are other transactions and details it can hold?*


So this means even if tampered in one branch we can find out. If one branch is hacked we can be alerted and get to safeguard other branch. Now, assume these branches as computer or nodes and the ledger is a transaction record or digital receipt. so this is the concept of Digital Ledger Technology.

*Do all node needs all the info in others nodes? Does this increase storage space in all nodes?*
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't make grammatical sense, please rephrase


## Blocks

In short a block is nothing but collections of records with a labelled header. These are connected cryptographically. Once a new block is added to a chain previous block is connected or precisely said as locked and will remain unaltered. we will see how this works once we dig deep into working mechanisms.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
In short a block is nothing but collections of records with a labelled header. These are connected cryptographically. Once a new block is added to a chain previous block is connected or precisely said as locked and will remain unaltered. we will see how this works once we dig deep into working mechanisms.
In short a block is nothing but collections of records with a labelled header. These are connected cryptographically. Once a new block is added to a chain previous block is connected or precisely said as locked and will remain unaltered. We will see how this works once we dig deep into working mechanisms.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi, Thanks for the feedback. As per above suggestions, I did changes to the document and committed it to this PR. Please revert back if any other changes are required in the document.

Commited the suggested changes and submitting for review.
@algorithms-keeper algorithms-keeper bot added the tests are failing Do not merge until tests pass label Nov 7, 2022
@GK3077 GK3077 requested a review from CaedenPH November 8, 2022 15:25
Changed a sentence that needed grammatical correction.
@algorithms-keeper algorithms-keeper bot removed the tests are failing Do not merge until tests pass label Nov 9, 2022
@GK3077
Copy link
Contributor Author

GK3077 commented Nov 9, 2022

Thank you for acknowledging my work. Hope to contribute more to the project.

@GK3077 GK3077 requested a review from CaedenPH November 10, 2022 11:18
Copy link
Contributor

@CaedenPH CaedenPH left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@cclauss Can you review please

@@ -1,7 +1,44 @@
# Blockchain

A Blockchain is a type of distributed ledger technology (DLT) that consists of growing list of records, called blocks, that are securely linked together using cryptography.
A Blockchain is a type of distributed ledger technology **(DLT)** that consists of growing list of records, called **blocks**, that are securely linked together using **cryptography**.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
A Blockchain is a type of distributed ledger technology **(DLT)** that consists of growing list of records, called **blocks**, that are securely linked together using **cryptography**.
A Blockchain is a type of **distributed ledger** technology (DLT) that consists of growing list of records, called **blocks**, that are securely linked together using **cryptography**.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the feedback. I have made the requested changes in this file. Please revert back if any other changes are required in the document.

Added the changes suggested by review panel
@GK3077 GK3077 requested a review from cclauss November 15, 2022 13:29
@algorithms-keeper algorithms-keeper bot removed the awaiting reviews This PR is ready to be reviewed label Nov 15, 2022
@cclauss cclauss merged commit 316e71b into TheAlgorithms:master Nov 15, 2022
Cjkjvfnby pushed a commit to Cjkjvfnby/Python that referenced this pull request Mar 13, 2023
* A deeper introduction to blockchain technology

* Update README.md

Rectified errors as image was not visible

* Delete img1.jpg

Deleting the image as it is not getting accepted in PR merge

* Delete img2.jpg

Deleting the image as it is not getting accepted in PR merge

* Update README.md

Removed all image s in the document

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update README.md

Commited the suggested changes and submitting for review.

* Update README.md

Changed a sentence that needed grammatical correction.

* Update README.md

Added the changes suggested by review panel

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This PR modified documentation files
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants