Add detailed documentation to demos
Registered by
Harish Narayanan
The demos would be more useful and easier to follow along if they contained in-file documentation.
Blueprint information
- Status:
- Complete
- Approver:
- None
- Priority:
- Undefined
- Drafter:
- None
- Direction:
- Needs approval
- Assignee:
- None
- Definition:
- Superseded
- Series goal:
- None
- Implementation:
-
Unknown
- Milestone target:
- None
- Started by
- Completed by
- Garth Wells
Related branches
Related bugs
Sprints
Whiteboard
HN: I think the demos would be far more useful if they all contained the following information:
1. What they are trying to do
2. Math related to what they are trying to do
3. References to papers and such for ideas, further reading and extensions
I have been going through some demos in Deal.II to understand how they do some things, and while the code is still a lot more lower level, it is really clarified by extensive documentation.
GNW: Superseded https:/
(?)
