Repository navigation
docs: put every public API in the reference, with its arguments - #94
Merged
Merged
Conversation
caop_variance, makestring, from_string and print_device_info are public and used, but were missing from the API reference, so the release notes' links to caop_variance did not resolve. caop_variance's Args also did not parse once rendered. The configuration and packing wrappers, green_function_from_coefficients, spectral_function, assemble_rdms and let_output_through now describe their arguments and return values. sbd_solver and device_config gain an __all__ of what is documented, leaving out create_sbd_solver (a partial of solve_sci_batch) and get_device_info. sbd.__all__ drops FCIDump, an empty object nothing uses, and a duplicate available_backends. All remain importable. "Refused" becomes "not supported" where a docstring states backend support. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Missing from the API reference.
sbd.analysis.caop_variance,sbd.makestring,sbd.from_stringandsbd.device_config.print_device_infoare public and used by the examples, but had no entry, so the release notes' links tocaop_variancedid not resolve. ItsArgs:section also did not parse once rendered, and now lists each argument.Arguments and return values.
TPB_SBD,GDB_SBD,CAOP_SBD,get_device_id,from_strings,from_string,makestring,sort_bitarray,sort_bitarray_array,green_function_from_coefficients,spectral_function,assemble_rdmsandlet_output_throughnow describe their arguments and what they return.assemble_rdmsandprint_device_infomove their implementation history into code comments.__all__.sbd.sbd_solverandsbd.device_configget one, listing what is documented. It leaves outcreate_sbd_solver, which isfunctools.partial(solve_sci_batch, ...), andget_device_info.sbd.__all__dropsFCIDump, which creates an empty object nothing uses (LoadFCIDumpis the entry point), and a duplicateavailable_backends. All of these remain importable by name.Wording. Where a docstring states backend support, "refused" becomes "not supported", and says that it raises
ValueError.Returns:lines that began "dict with keys" no longer render as a broken type link.Checked: the docs build with
-Wand no warnings, and with-nwith no unresolved reference inside the package; the new entries render; every__all__name resolves; the tests importing these names pass.🤖 Generated with Claude Code