Skip to content

Document interface of library - #346

Merged
mtfishman merged 26 commits into
mainfrom
MS_doc_interface
May 6, 2026
Merged

Document interface of library#346
mtfishman merged 26 commits into
mainfrom
MS_doc_interface

Conversation

@emstoudenmire

@emstoudenmire emstoudenmire commented Apr 27, 2026

Copy link
Copy Markdown
Contributor

This PR adds documentation of which methods we may consider "interface", and thus should keep and add docstrings for, versus deprecated methods we may want to delete. Methods not in the two files interface_methods.md and deprecated_methods.md are considered internal, developer-facing methods.

@github-actions

github-actions Bot commented Apr 27, 2026

Copy link
Copy Markdown
Contributor

Your PR no longer requires formatting changes. Thank you for your contribution!

Comment thread docs/src/interface_methods.md Outdated
Comment thread docs/src/interface_methods.md Outdated
Comment thread docs/src/deprecated_methods.md
Comment thread docs/src/deprecated_methods.md Outdated
Comment thread docs/src/deprecated_methods.md
Comment thread docs/src/interface_methods.md Outdated
@codecov

codecov Bot commented Apr 27, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 73.23%. Comparing base (2f4ab3d) to head (ad1e38f).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #346      +/-   ##
==========================================
- Coverage   73.26%   73.23%   -0.04%     
==========================================
  Files          66       66              
  Lines        3183     3183              
==========================================
- Hits         2332     2331       -1     
- Misses        851      852       +1     
Flag Coverage Δ
docs 47.13% <ø> (-0.04%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ 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.

Comment thread docs/src/interface_methods.md Outdated
Comment thread docs/src/interface_methods.md Outdated
@mtfishman

Copy link
Copy Markdown
Member

@emstoudenmire can you bump the version, fix the docs build, and format just so we can get tests passing?

Also, I noticed you are just including the function signatures in the docs. For functions that have docstrings, can you insert the docstring instead of just putting the function signature?

Comment thread docs/src/interface_methods.md Outdated
Comment thread docs/src/interface_methods.md Outdated
Comment thread docs/src/interface_methods.md Outdated
Comment thread docs/src/interface_methods.md Outdated
Comment thread docs/src/interface_methods.md Outdated
Comment thread docs/src/interface_methods.md Outdated
Comment thread docs/src/interface_methods.md Outdated
@mtfishman
mtfishman marked this pull request as ready for review April 30, 2026 14:08
Comment thread docs/src/interface_methods.md Outdated
Comment thread docs/src/interface_methods.md Outdated
Comment thread docs/src/interface_methods.md Outdated
Comment thread docs/src/experimental_methods.md Outdated
Comment thread docs/src/interface_methods.md Outdated
@emstoudenmire

Copy link
Copy Markdown
Contributor Author

By the way, the interface page has gotten quite small... It's nice to see. Once we can build the main features back on top (assuming they aren't already) , such as BP, constructor codes (e.g. fermionic states) based on BP, and solvers, that will be a good situation.

@emstoudenmire

Copy link
Copy Markdown
Contributor Author

Ready to merge this? Or let me know if other changes seem needed.

Comment thread docs/src/deprecated_methods.md
Comment thread docs/src/interface_methods.md Outdated
@mtfishman
mtfishman enabled auto-merge (squash) May 6, 2026 20:48
@mtfishman
mtfishman merged commit c0fecc0 into main May 6, 2026
17 of 18 checks passed
@mtfishman
mtfishman deleted the MS_doc_interface branch May 6, 2026 21:11
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.

3 participants