The dolfin reference documentation regularly does not provide sufficient information for even basic use
Registered by
Martin Sandve Alnæs
In many cases the python docstring only shows "*args" and no description of the arguments, and the reference documentation is no better. One example was Cylinder (now fixed):
"""
This class describes a 3D cylinder which can be used to build
geometries using Constructive Solid Geometry (CSG). A cylinder
is here just a special case of a cone.
Constructor information:
Definition:
"""
Where the programmers reference was no more useful.
But this is far from the only case. Shouldn't the programmers reference at least show argument names and types automatically?
Blueprint information
- Status:
- Not started
- Approver:
- None
- Priority:
- Medium
- Drafter:
- None
- Direction:
- Approved
- Assignee:
- None
- Definition:
- New
- Series goal:
- None
- Implementation:
-
Unknown
- Milestone target:
- None
- Started by
- Completed by
Whiteboard
(?)
