Skip to content

Reposition documentation as an ASE extension#522

Merged
jan-janssen merged 2 commits into
mainfrom
docs/position-as-ase-extension
Jun 26, 2026
Merged

Reposition documentation as an ASE extension#522
jan-janssen merged 2 commits into
mainfrom
docs/position-as-ase-extension

Conversation

@jan-janssen

Copy link
Copy Markdown
Member

The README still framed structuretoolkit as an early-stage library spun out of pyiron_atomistics ("currently under development"). Update the README intro and the API docs landing page to lead with the ase.atoms.Atoms-based framing already used in the introduction notebook, and drop the stale disclaimer.

The README still framed structuretoolkit as an early-stage library
spun out of pyiron_atomistics ("currently under development"). Update
the README intro and the API docs landing page to lead with the
ase.atoms.Atoms-based framing already used in the introduction
notebook, and drop the stale disclaimer.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

Warning

Review limit reached

@jan-janssen, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 21 minutes and 19 seconds. Learn how PR review limits work.

Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits.

🚦 How do rate limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 4712f0eb-c9ba-4630-b54d-ff93d69e0e5f

📥 Commits

Reviewing files that changed from the base of the PR and between dd849b0 and 183f3b5.

📒 Files selected for processing (2)
  • README.md
  • docs/api.rst
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/position-as-ase-extension

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.

The feature list was just bare function names, giving no indication of
what each function is for. Add a one-line summary to every entry,
based on each function's docstring, so the list works as a quick
reference.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@codecov

codecov Bot commented Jun 26, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.90%. Comparing base (dd849b0) to head (183f3b5).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #522   +/-   ##
=======================================
  Coverage   97.90%   97.90%           
=======================================
  Files          29       29           
  Lines        2004     2004           
=======================================
  Hits         1962     1962           
  Misses         42       42           

☔ View full report in Codecov by Harness.
📢 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.

@jan-janssen jan-janssen merged commit 482290d into main Jun 26, 2026
22 checks passed
@jan-janssen jan-janssen deleted the docs/position-as-ase-extension branch June 26, 2026 20:48
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.

1 participant