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: suggestive improvements on introduction #1784

Merged
merged 1 commit into from
Oct 20, 2023
Merged

docs: suggestive improvements on introduction #1784

merged 1 commit into from
Oct 20, 2023

Conversation

pieterjanscheir
Copy link
Contributor

Fixed inconsistency in docs related to bundle size

Description

The small bundle size of 3kb is an important feature of the package. Therefor I believe it's important to leave out a possible missunderstanding in the example code blocks where it is stated that the bundle size is 5kb.

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

Fixes # (issue)

Checklist

  • I have read the CONTRIBUTING and CODE_OF_CONDUCT docs
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

Fixed inconsistency in docs related to bundle size
@vercel
Copy link

vercel bot commented Oct 19, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
js-lingui ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 19, 2023 11:14am

@pieterjanscheir pieterjanscheir changed the title Update introduction.md feat: minor improvement in documentation Oct 19, 2023
@github-actions
Copy link

size-limit report 📦

Path Size
./packages/core/dist/index.mjs 2.83 KB (0%)
./packages/detect-locale/dist/index.mjs 721 B (0%)
./packages/react/dist/index.mjs 1.68 KB (0%)
./packages/remote-loader/dist/index.mjs 7.24 KB (0%)

@andrii-bodnar andrii-bodnar changed the title feat: minor improvement in documentation docs: minor improvement in documentation Oct 19, 2023
@codecov
Copy link

codecov bot commented Oct 19, 2023

Codecov Report

All modified lines are covered by tests ✅

Comparison is base (40d1556) 76.27% compared to head (17bf118) 76.27%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1784   +/-   ##
=======================================
  Coverage   76.27%   76.27%           
=======================================
  Files          81       81           
  Lines        2074     2074           
  Branches      529      529           
=======================================
  Hits         1582     1582           
  Misses        380      380           
  Partials      112      112           

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

@pieterjanscheir pieterjanscheir changed the title docs: minor improvement in documentation docs: suggestive improvements in introduction Oct 19, 2023
@pieterjanscheir pieterjanscheir changed the title docs: suggestive improvements in introduction docs: suggestive improvements on introduction Oct 19, 2023
@andrii-bodnar andrii-bodnar merged commit cfcc65c into lingui:main Oct 20, 2023
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.

2 participants