Skip to content

Improve documentation for NumberedObjectCollections on Slicing behavior #798

@MicahGale

Description

@MicahGale

As brought up in #793, the slicing behavior of NumberedObjecCollection (e.g., Cells, Materials) is not the most intuitive as it's not traditional pythonic. This was done intentionally, however, this behavior is poorly documented.

To resolved this:

  1. Update all subclasses with documentation of this in their doc strings, not just in NumberedObjectCollection
  2. Clarify this in the tutorial
  3. Correct an error in the jupyter tutorials.

Metadata

Metadata

Assignees

Labels

code improvementA feature request that will improve the software and its maintainability, but be invisible to users.documentationImprovements or additions to documentationhacktoberfest🎃 https://hacktoberfest.com/participation/

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions