LLM Readiness

[OndrejPanek-ext]

Task description

The public API of pyOptiSLang shall be made LLM-readable by ensuring all public classes, methods and functions have comprehensive, well-structured dosctrings. Additionally, LLM access files shall be provided to enable AI coding assistants to effectively work with the PyOptiSLang codebase.

Implementation

• docstrings reviewed and refined / fixed
• 3 access files created (AGENTS.md, llms.txt, .cursor/rules/docstrings.md)

[codecov-commenter]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 75.32%. Comparing base (472d968) to head (5bfca87).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #583   +/-   ##
=======================================
  Coverage   75.32%   75.32%           
=======================================
  Files          22       22           
  Lines        3250     3250           
=======================================
  Hits         2448     2448           
  Misses        802      802           

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.