Skip to content

Fix README accuracy and structure (#22)#25

Merged
sacchen merged 1 commit into
mainfrom
fix/issue-22-readme-accuracy
Apr 11, 2026
Merged

Fix README accuracy and structure (#22)#25
sacchen merged 1 commit into
mainfrom
fix/issue-22-readme-accuracy

Conversation

@sacchen

@sacchen sacchen commented Apr 11, 2026

Copy link
Copy Markdown
Owner

Summary

Accuracy fixes (#22)

  • Parsing section: separate always-on normalizations ({}->(), ln->log, ODE/Leibniz/LaTeX shorthand) from relaxed-only implicit multiplication (2x, sinx) — the previous README grouped them all under "relaxed parsing" which misstated what --strict does
  • :tutorial docs: now says "start interactive tutorial mode" instead of "show guided first-run tour"
  • WolframAlpha hint wording: softened to "most evaluation errors" with note that it's suppressed for some guardrail failures
  • Update-status: describes the two-line case (badge + upgrade command) when an update is available

Structural changes

  • Merge 60-Second Start and Learn by Doing into a single Quick Start near the top
  • Remove Inspiration, Release, Safety limits (not user-facing; Release moved to CONTRIBUTOR.md pointer)
  • Fold WolframAlpha Helper into Output and Interop
  • Merge Local Development Install into Development
  • Move Examples above Reference
  • Inline Roadmap link in Install section
  • Fix --color auto|always|never presentation in bash block (was valid pipe syntax in shell)

ROADMAP

  • Add missing solve() ergonomics bullet to v0.3.0 scope (was described in the issue but absent from the file)

Closes #22

Accuracy fixes:
- Separate always-on normalizations from relaxed-only implicit multiplication
  ({}->(), ln->log, ODE/Leibniz/LaTeX shorthand apply in all modes; 2x/sinx are relaxed-only)
- Fix :tutorial docs: starts interactive tutorial mode, not just shows a tour
- Soften WolframAlpha hint wording: suppressed for some local guardrail failures
- Fix update-status: describes the two-line case when an update is available

Structure:
- Merge 60-Second Start and Learn by Doing into a single Quick Start near the top
- Remove Inspiration, Release, Safety limits (not user-facing)
- Fold WolframAlpha Helper into Output and Interop
- Merge Local Development Install into Development
- Move Examples above Reference
- Inline Roadmap link in Install

ROADMAP: add missing solve() ergonomics bullet to v0.3.0 scope

Closes #22

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@sacchen
sacchen merged commit 4174874 into main Apr 11, 2026
10 checks passed
@sacchen
sacchen deleted the fix/issue-22-readme-accuracy branch April 11, 2026 06:24
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.

README overstates strict-vs-relaxed parsing and a few REPL/error behaviors

1 participant