-
Notifications
You must be signed in to change notification settings - Fork 1
Restructure README documentation sections #40
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
Conversation
Co-authored-by: Sander-Toonen <5106372+Sander-Toonen@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Restructures the README to better separate project background from the main description and improve section ordering for discoverability.
Changes:
- Refocuses the Description section on broader expression capabilities (strings/objects/arrays), not just math.
- Moves Playground Example above Documentation.
- Adds a new Origins section near the end (before License) describing lineage and modernization.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| **This is a modern TypeScript port of the expr-eval library, completely rewritten with contemporary build tools and development practices.** Originally based on [expr-eval 2.0.2](http://silentmatt.com/javascript-expression-evaluator/), this version has been restructured with a modular architecture, TypeScript support, and comprehensive testing using Vitest. | ||
|
|
||
| Parses and evaluates mathematical expressions. It's a safer and more math-oriented alternative to using JavaScript's `eval` function for mathematical expressions. | ||
| A versatile expression evaluation library that goes beyond mathematical expressions. It parses and evaluates expressions that can manipulate strings, objects, and arrays, providing a safer alternative to JavaScript's `eval` function. |
Copilot
AI
Jan 24, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The updated README description says the library goes beyond mathematical expressions (strings/objects/arrays), but the published docs still frame it as a mathematical expression evaluator (e.g., docs/index.md:5 and docs/index.md:11). This creates conflicting messaging for users. Consider updating the docs’ intro/tagline to match this new positioning, or rewording the README description to stay consistent with the existing docs until those are updated.
| A versatile expression evaluation library that goes beyond mathematical expressions. It parses and evaluates expressions that can manipulate strings, objects, and arrays, providing a safer alternative to JavaScript's `eval` function. | |
| A mathematical expression evaluation library for JavaScript. It parses and evaluates expressions with support for numbers, strings, objects, and arrays, providing a safer alternative to JavaScript's `eval` function. |
README restructuring to separate origins from description and improve section ordering.
Changes
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.