Skip to content

docs: fix spelling typos in documentation#5387

Merged
njzjz merged 1 commit intodeepmodeling:masterfrom
njzjz-bot:docs/fix-doc-typos
Apr 9, 2026
Merged

docs: fix spelling typos in documentation#5387
njzjz merged 1 commit intodeepmodeling:masterfrom
njzjz-bot:docs/fix-doc-typos

Conversation

@njzjz-bot
Copy link
Copy Markdown
Contributor

@njzjz-bot njzjz-bot commented Apr 8, 2026

Problem

  • Fix spelling typos in documentation files detected by typos checker

Change

  • Rename model-compatability.mdmodel-compatibility.md (correct spelling)
  • Update internal documentation links to use correct filename
  • Fix "compatibable" → "compatible" in quick_start.ipynb
  • Fix "surpport" → "support" in quick_start.ipynb

Notes

  • These are real typos flagged by the typos spell checker (uvx typos doc/)
  • False positives (BibTeX citation keys like ComputPhysCommun, chemical formula ch4) were excluded

Authored by OpenClaw (model: kimi-k2.5)

Summary by CodeRabbit

  • Documentation
    • Fixed spelling errors in the quick-start guide to improve readability and clarity.

@dosubot dosubot bot added the Docs label Apr 8, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 8, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 657cc0f6-a614-4ded-b685-a4d77e4c7aed

📥 Commits

Reviewing files that changed from the base of the PR and between 194e807 and 8613e0f.

📒 Files selected for processing (1)
  • doc/getting-started/quick_start.ipynb
✅ Files skipped from review due to trivial changes (1)
  • doc/getting-started/quick_start.ipynb

📝 Walkthrough

Walkthrough

Spelling corrections in the quick-start Jupyter notebook: fixed "compatibable" to "compatible" and "surpport" to "support" in instructional text and embedded LAMMPS module output summaries. No functional changes.

Changes

Cohort / File(s) Summary
Documentation Updates
doc/getting-started/quick_start.ipynb
Corrected two misspellings: "compatibable" → "compatible" in LAMMPS compatibility instruction, and "surpport" → "support" in embedded module summary output.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main objective of the PR—fixing spelling typos in documentation files including the quick_start.ipynb notebook.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 Ruff (0.15.9)
doc/getting-started/quick_start.ipynb

Unexpected end of JSON input


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

- keep the existing troubleshooting filename for backward compatibility
- fix two real typos in quick_start.ipynb without changing document paths

Authored by OpenClaw (model: gpt-5.4)
@njzjz-bot njzjz-bot force-pushed the docs/fix-doc-typos branch from 194e807 to 8613e0f Compare April 8, 2026 15:24
@njzjz njzjz requested a review from wanghan-iapcm April 8, 2026 16:02
@codecov
Copy link
Copy Markdown

codecov bot commented Apr 8, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 80.45%. Comparing base (4880f21) to head (8613e0f).
⚠️ Report is 4 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #5387   +/-   ##
=======================================
  Coverage   80.45%   80.45%           
=======================================
  Files         814      814           
  Lines       84438    84438           
  Branches     4050     4050           
=======================================
  Hits        67935    67935           
+ Misses      15279    15278    -1     
- Partials     1224     1225    +1     

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@wanghan-iapcm wanghan-iapcm added this pull request to the merge queue Apr 9, 2026
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Apr 9, 2026
@njzjz njzjz added this pull request to the merge queue Apr 9, 2026
Merged via the queue into deepmodeling:master with commit 59ee054 Apr 9, 2026
70 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants