DOC: Document info property and add v0.31.1 release notes#237
Merged
Conversation
* Expand the Interface.info docstring with an experimental-feature warning, a Model bullet, the bases field on spaces, is_derived on cells, and example output for Model, UserSpace, ItemSpace, DynamicSpace, and Cells so each subclass's auto-generated reference page documents its own usage. * Add release notes for v0.31.1 highlighting the info property under Enhancements with links to info on each Interface subclass.
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
1 participant
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.
Summary
Interface.infodocstring with an experimental-feature warning, a Model bullet, the newbasesfield on spaces,is_derivedon cells, and example output for Model, UserSpace, ItemSpace, DynamicSpace, and Cells. Because each subclass's auto-generated reference page renders this docstring, the examples now cover every concrete type.doc/source/releases/relnotes_v0_31_1.rst(release date 2026-05-31) that describesinfounder Enhancements with links to it on each Interface subclass.whatsnew.rstandupdates.rst.Notes for reviewer
Test plan
inforeference pages render correctly under Model, UserSpace, ItemSpace, DynamicSpace, and Cells.info.