DESC
DESC copied to clipboard
Clarify documentation
trafficstars
A running list of things to add or clarify in the documentation:
- [ ] Structure/data type of compute data. For most
Optimizableobjects,thing.computereturns a dictionary of the computed quantities. But for anOptimizableCollectionlike aCoilSet, it returns a list of dictionaries. - [x] #1027 should explain that
basisis a possiblekwargfor compute and that default isrpzfor every vector/tensor quantity - [x] Show uses of some utility functions somewhere in the docs, or make them part of the public API https://github.com/PlasmaControl/DESC/issues/723
#723
Closing as the remaining point is mentioned in docstring of the related classes