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

Documentation Typo Fixes for Motoko Base Library Design Guide #607

Merged
merged 2 commits into from
Dec 18, 2023

Conversation

joaolago1113
Copy link
Contributor

Overview

This pull request addresses several typographical errors in the Motoko Base Library's design documentation. Ensuring accuracy and clarity in our documentation is vital for effective communication among developers and for maintaining the high standard of our project.

Changes Made

  • Corrected 'encapsultion' to 'encapsulation' in the Classes section. This change clarifies the intended meaning, emphasizing the importance of encapsulation in abstract data types.
  • Updated 'valus' to 'values' in the Containers section under the description of the keys iterator. This fix ensures that the documentation accurately represents the functionality of the iterator.
  • Fixed 'distinghuish' to 'distinguish' in the Containers section. This modification aids in presenting a clearer rationale for the choice of the put method name over set, especially in the context of sets and other containers.

Impact

These changes, while minor, contribute to the overall readability and professionalism of our documentation. They do not affect the actual functionality of the codebase but are essential for consistent and error-free documentation.

Additional Notes

While reviewing the documentation, I've noticed a few areas where further clarification might be beneficial. I plan to propose additional updates in subsequent pull requests to continuously improve the documentation.

…, 'valus' to 'values', and 'distinghuish' to 'distinguish'.
@sa-github-api
Copy link

Dear @joaolago1113,

In order to potentially merge your code in this open-source repository and therefore proceed with your contribution, we need to have your approval on DFINITY's CLA.

If you decide to agree with it, please visit this issue and read the instructions there. Once you have signed it, re-trigger the workflow on this PR to see if your code can be merged.

— The DFINITY Foundation

@ggreif
Copy link
Contributor

ggreif commented Dec 17, 2023

Obrigado pelas correções! Infelizmente estamos péssimos com a linguagem natural 😜

@joaolago1113
Copy link
Contributor Author

@ggreif Obrigado! Sempre pronto para mais uma ronda de bug fixing, seja no código ou na língua! 😄🔍

@chenyan-dfinity chenyan-dfinity merged commit 92a6a49 into dfinity:master Dec 18, 2023
6 checks passed
@ggreif
Copy link
Contributor

ggreif commented Dec 18, 2023

@joaolago1113 Colega já fechou este, se vc. achar mais, seja convidado de abrir um outro. Obrigado de novo!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants