Refine descriptions in paper.md for clarity

[zhubonan]

Some minor adjustment for the paper.md

Summary by CodeRabbit

• Documentation
  • Clarified how SMACT overlaps with Pymatgen at the composition level and how its native Doper workflow differs.
  • Updated descriptions of validity screening and composition-only band-gap prediction, including references to oxidation-state filtering, species-embedding similarities and a pretrained ROOST model.
  • Revised author contribution and acknowledgement wording, including the funding body’s name.

[coderabbitai]

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Advanced

Run ID: 478fcc79-e296-4906-a092-687ed234fb75

📥 Commits

Reviewing files that changed from the base of the PR and between 05a23f8 and 4621134.

📒 Files selected for processing (1)

• joss/paper.md

Included review availability: This review used your included allowance. Your plan provides up to 2 included reviews per hour; 1 remain after this review.

---

Walkthrough

The JOSS paper revises descriptions of SMACT’s overlap with Pymatgen, its methods and modules, author contributions, and funding attribution.

Changes

JOSS paper wording

Layer / File(s)	Summary
Technical descriptions and attribution joss/paper.md	The paper clarifies SMACT’s composition-level overlap with Pymatgen and revises descriptions of validity screening and band-gap prediction. It updates author-contribution wording and names EPSRC in the funding acknowledgement.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~4 minutes

Change: Other

Suggested reviewers: kingamas

Merge Risk: ⚪ Minimal · up to 46211

This paper-only update has no demonstrated material error in the available evidence, so no concrete merge-blocking risk is established.

Architecture Summary

Architecture risk: 🔵 Low · up to 46211

The change affects 1 system.

Changed systems: joss

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

• observed — joss (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

• observed — Modified behavior in joss/paper.md: The comparison with Pymatgen now describes its substitution model as “ionic” and clarifies overlap at composition level. The passage also specifies SMACT’s electronegativity rule, AI-generated materials, and band-gap prediction terminology.
• observed — Modified behavior in joss/paper.md: The module descriptions now refer to oxidation-state filtering and species-embedding similarities, and describe a pretrained ROOST model for predicting band gaps.
• observed — Modified behavior in joss/paper.md: The author-contribution statements retain the existing attribution while revising wording for oxidation-state improvements and the AIchemy SMACT hackathon.
• observed — Modified behavior in joss/paper.md: The funding acknowledgement now names the Engineering and Physical Sciences Research Council (EPSRC), replacing “Engineering and Physical Sciences Research Council (UKRI)”.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The description is too brief and does not satisfy the required template. It omits the change summary, issue reference, motivation, dependencies, change type, testing details, reviewers, and checklist …	Expand the description to complete the required sections. State the changes made to paper.md, add the issue reference or explain why none applies, identify the documentation change type, describe testing and test configuration, name reviewe…

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and concisely describes the main change: improving the clarity of descriptions in paper.md.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

Full details: Description check

Explanation

The description is too brief and does not satisfy the required template. It omits the change summary, issue reference, motivation, dependencies, change type, testing details, reviewers, and checklist status.

Resolution

Expand the description to complete the required sections. State the changes made to paper.md, add the issue reference or explain why none applies, identify the documentation change type, describe testing and test configuration, name reviewers and their roles, and complete the checklist.

• Fix all pre-merge checks with AI

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create a new PR

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{A rabbit reads the paper in the sun
New words hop neatly into place
ROOST rests among the lines
EPSRC gets its name
Then off I go, with one last nibble of praise}

_{Comment @coderabbitai help to get the list of available commands.}

[KingaMas]

@zhubonan , thank you for your corrections! I'm approving the merge