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

docs: fix grammatical errors #454

Closed
wants to merge 6 commits into from

Conversation

cratiu222
Copy link
Contributor

This PR corrects several grammatical errors in the documentation and comments, improving readability and clarity. These changes enhance the overall quality of the project’s written content.

Hope it helps.

@batzor batzor changed the title Docs improvements docs: fix grammatical errors Jun 29, 2024
Copy link
Contributor

@ashjeong ashjeong left a comment

Choose a reason for hiding this comment

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

Thanks for the contribution! I gave a few comments, but besides that looks good~

tachyon/base/containers/circular_deque.h Outdated Show resolved Hide resolved
tachyon/base/containers/circular_deque.h Show resolved Hide resolved
@cratiu222
Copy link
Contributor Author

solved the comments

@chokobole
Copy link
Contributor

@cratiu222 Sorry for the late reply. Please follow the commit convention

Copy link
Contributor

@dongchangYoo dongchangYoo left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@TomTaehoonKim TomTaehoonKim left a comment

Choose a reason for hiding this comment

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

LGTM but let's fix the commit messages before merging

@cratiu222
Copy link
Contributor Author

LGTM but let's fix the commit messages before merging

what needs to be fixed?

@dongchangYoo
Copy link
Contributor

dongchangYoo commented Jul 19, 2024

LGTM but let's fix the commit messages before merging

what needs to be fixed?

We require relatively strict conventions for the users of the code.
For example, in the case of a fix process_handle.h commit, chore(docs): fix typo or chore(docs): fix typo in process_handle.h would be appropriate.

Additionally, the last two commits should be squashed into one since they modify the same file with the same content.

@batzor
Copy link
Contributor

batzor commented Aug 9, 2024

@chokobole @dongchangYoo I think we can squash merge this? If not let's close this PR as stale.

@chokobole
Copy link
Contributor

Close this PR, since it hasn't been updated so long.

@chokobole chokobole closed this Aug 9, 2024
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.

6 participants