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 Improvements and Typo Fixes #3907

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Hopium21
Copy link

@Hopium21 Hopium21 commented Nov 21, 2024

  1. In README.md:
  • To test as if running on CI, one must limit the number of cores and ram to match github runners (2 core, 7 gig ram)
  • To test as if running on CI, one must limit the number of cores and ram to match github runners (2 cores, 7GB RAM)
    Reason: Improves technical accuracy by using proper pluralization and standard units (GB RAM instead of gig ram)
  • code coveragte statistics
  • code coverage statistics
    Reason: Fixes typo in the word "coverage" to improve documentation readability
  1. In crates/examples/push-cdn/README.md:
  • The only thing we run it with is with --requirepass to set a password.
  • The only thing we run it with --requirepass to set a password.
    Reason: Removes redundant "with" to improve sentence clarity

@CLAassistant
Copy link

CLAassistant commented Nov 21, 2024

CLA assistant check
All committers have signed the CLA.

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