API Documentation
- Dominant language
- Python
- Stars
- 9
- Forks
- 1
- Avg merge
- 2d 9h
- Merged PRs (30d)
- 10
Description
- API Documentation
- [ ] #662
- [ ] #663
- [ ] #665
- [ ] #666
- explain concept
- Done:
- Rework doc of enums (types). Skip inheritance.
- All entities below model:
- Links to parameter types don't work (e.g. enums).
- Explain "store" concept
- create_* functions on model don't show types and defaults are just shown as strings even if they are enums
- Entities in tree are ordered like in ACP. Should be sorted alphabetically
- Autocompletion does not work when creating entities (e.g. what are the arguments). Jump to definition also does not help.
- Model
- delete misses docs
- mesh: Link to MeshData does not work
- Material:
- property sets are missing types
- Element sets
- Parameter docs missing
- Material property sets
- Missing docs and types
- Field Variable:
- Missing docs and types
- Interpolation options:
- Missing docs and types
- Other data types:
- Missing docs and types
Contributor guide
Research direction
Start by reviewing linked issues #662, #663, #665, and #666 alongside the existing API documentation. The work is done when the listed entity, type, parameter, default-value, link, ordering, autocomplete, and definition documentation gaps are addressed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100