Fix hyphenation in README#4084
Conversation
Hi maintainers 👋 I noticed a minor hyphenation issue in the README and fixed it. Change: - Updated "Express inspired" → "Express-inspired" Thank you for your work on Fiber 🙂
Summary of ChangesHello @23f2005050, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request addresses a small but important grammatical correction within the project's README file. The change specifically targets a hyphenation inconsistency, ensuring that the phrase describing Fiber's inspiration is correctly formatted. This refinement enhances the overall professionalism and clarity of the project's introductory documentation. Highlights
Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
WalkthroughThis pull request updates the README documentation, changing the phrasing "Fiber is inspired by Express" to "Fiber is Express-inspired" in the Philosophy section to improve clarity. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
No actionable comments were generated in the recent review. 🎉 Tip Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Code Review
This pull request aims to fix a perceived hyphenation issue in the README.md file by changing 'inspired by Express' to 'Express-inspired'. However, the original phrasing was grammatically correct and arguably clearer. The proposed change introduces a slightly awkward sentence structure and removes intentional emphasis. My review includes a comment suggesting to revert this change to restore the original, more readable text.
| New gophers that make the switch from [Node.js](https://nodejs.org/en/about/) to [Go](https://go.dev/doc/) are dealing with a learning curve before they can start building their web applications or microservices. Fiber, as a **web framework**, was created with the idea of **minimalism** and follows the **UNIX way**, so that new gophers can quickly enter the world of Go with a warm and trusted welcome. | ||
|
|
||
| Fiber is **inspired** by Express, the most popular web framework on the Internet. We combined the **ease** of Express and **raw performance** of Go. If you have ever implemented a web application in Node.js (_using Express or similar_), then many methods and principles will seem **very common** to you. | ||
| Fiber is Express-inspired, the most popular web framework on the Internet. We combined the **ease** of Express and **raw performance** of Go. If you have ever implemented a web application in Node.js (_using Express or similar_), then many methods and principles will seem **very common** to you. |
There was a problem hiding this comment.
Thank you for your contribution. The original phrasing **inspired** by Express was grammatically correct and clear. The new phrasing 'Fiber is Express-inspired...' is less standard, as compound adjectives like 'Express-inspired' are typically used before a noun (e.g., 'an Express-inspired framework'). The original phrasing is more common and readable in this context. Furthermore, this change removes the bold formatting, which was likely intended for emphasis. For these reasons, reverting to the original text is recommended.
| Fiber is Express-inspired, the most popular web framework on the Internet. We combined the **ease** of Express and **raw performance** of Go. If you have ever implemented a web application in Node.js (_using Express or similar_), then many methods and principles will seem **very common** to you. | |
| Fiber is **inspired** by Express, the most popular web framework on the Internet. We combined the **ease** of Express and **raw performance** of Go. If you have ever implemented a web application in Node.js (_using Express or similar_), then many methods and principles will seem **very common** to you. |
|
@23f2005050 The change is grammatically incorrect. The correct way in English is |
Hi maintainers 👋
I noticed a minor hyphenation issue in the README and fixed it.
Change:
Thank you for your work on Fiber 🙂
Description
Please provide a clear and concise description of the changes you've made and the problem they address. Include the purpose of the change, any relevant issues it solves, and the benefits it brings to the project. If this change introduces new features or adjustments, highlight them here.
Fixes # (issue)
Changes introduced
List the new features or adjustments introduced in this pull request. Provide details on benchmarks, documentation updates, changelog entries, and if applicable, the migration guide.
Type of change
Please delete options that are not relevant.
Checklist
Before you submit your pull request, please make sure you meet these requirements:
/docs/directory for Fiber's documentation.Commit formatting
Please use emojis in commit messages for an easy way to identify the purpose or intention of a commit. Check out the emoji cheatsheet here: CONTRIBUTING.md