Skip to content
This repository has been archived by the owner on Jan 9, 2025. It is now read-only.

Improve clarity and grammatical accuracy in technical descriptions #1663

Closed
wants to merge 2 commits into from

Conversation

detrina
Copy link

@detrina detrina commented Dec 11, 2024

Changes:

  • Changed "As Kakarot's state is embedded into the Starknet chain it is deployed on" to "As Kakarot's state is embedded in the Starknet chain where it is deployed" for better readability.
  • Corrected "which are our dict-based data" to "which as our dict-based data" for grammatical accuracy.
  • Updated "There is only one instance of the Memory and the Stack, which is shared" to "There only one instance of Memory and Stack, which are shared" for clarity and consistency.

These changes are beneficial because:

Clarity and precision: Changes like "embedded in" instead of "embedded into" help express more accurately how Kakarot's state is related to the Starknet network. Additionally, "where it is deployed" makes the sentence structure simpler and easier to understand.

Grammatical accuracy: Correcting "which are our dict-based data" to "which as our dict-based data" eliminates a grammatical error and makes the sentence more logically coherent. This helps readers grasp the meaning more easily.

Consistency and readability: Modifying "There is only one instance of the Memory and the Stack, which is shared" to "There only one instance of Memory and Stack, which are shared" improves consistency in terminology and prevents confusion in technical descriptions, making them more precise and comprehensible.

@detrina
Copy link
Author

detrina commented Dec 18, 2024

@ClementWalter Hey! Could you please review my corrections?

I hope I was able to help in some way. Thank you for your work.

@Eikix
Copy link
Member

Eikix commented Jan 8, 2025

Sorry for the late reply. We've been pausing the development of kakarot for now.

I'm cognizant that you spent some time doing this PR, so thank you. I will have to close it since I am cleaning a bit the repo and preparing for archival.

Archiving the repo will solve issue of people working on stuff while we are not accepting new PRs.
Thanks for understanding

@Eikix Eikix closed this Jan 8, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants