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

Explanation of the Importance of Correcting These Errors #791

Merged
merged 6 commits into from
Nov 28, 2024

Conversation

futreall
Copy link
Contributor

  1. "transaprent" → "transparent"

    • This typo disrupts the proper spelling of the word and can confuse the reader. In technical documentation, accuracy is critical, and an error in a key term like "transparent" could lead to misunderstandings.
  2. "they to go through" → "them to go through"

    • This is a grammatical error. In English, after the verb "allow," the object pronoun "them" should be used (instead of "they"). Using "they" in this context makes the sentence grammatically incorrect and harder to understand.
  3. "communication to each other" → "communicate with each other"

    • This is a mistake in using the noun "communication" instead of the verb "communicate." In this context, it's more appropriate to use the verb "communicate," as it expresses an action rather than an abstract noun. This is important for proper sentence construction.
  4. "catastrophical" → "catastrophic"

    • "Catastrophical" is not a valid word in English. The correct term is "catastrophic." An error in such an important term could cause confusion and lower the professionalism of the documentation.

Copy link
Contributor

@mpguerra mpguerra left a comment

Choose a reason for hiding this comment

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

Thank you for correcting those typos!

book/src/zcash/technical-details.md Outdated Show resolved Hide resolved
Copy link

codecov bot commented Nov 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.40%. Comparing base (5f4ac6e) to head (c8b450b).
Report is 69 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #791      +/-   ##
==========================================
+ Coverage   82.18%   83.40%   +1.21%     
==========================================
  Files          31       37       +6     
  Lines        3188     4061     +873     
==========================================
+ Hits         2620     3387     +767     
- Misses        568      674     +106     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.


🚨 Try these New Features:

mergify bot added a commit that referenced this pull request Nov 28, 2024
@mergify mergify bot merged commit 3100f8f into ZcashFoundation:main Nov 28, 2024
18 of 19 checks passed
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.

2 participants