Document interface of library - #346
Conversation
…recated will be considered internal.)
|
Your PR no longer requires formatting changes. Thank you for your contribution! |
Codecov Report✅ All modified and coverable lines are covered by tests. 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
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
@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? |
|
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. |
|
Ready to merge this? Or let me know if other changes seem needed. |
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.mdanddeprecated_methods.mdare considered internal, developer-facing methods.