-
Notifications
You must be signed in to change notification settings - Fork 1
Open
Labels
Topic: DocumentationImprovements or additions to documentationImprovements or additions to documentationType: EnhancementNew feature or requestNew feature or request
Milestone
Description
Is your feature request related to a problem? Please describe.
A standard for documenting a diagnostic.
What are the essential elements needed to uniquely describe a diagnostic.
- Name
- Function
- Plotting function(s)
- Type (Model2Self, Model2Ref, etc.)
- Description
- Reference? If existing? For uniquer plots/calculations?
- ?
Describe the solution you'd like
- Add these to the Diagnostic objects
- Add these to the pre-made diagnostic docs
- Ensure that the examples include the correct required function signature
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
Topic: DocumentationImprovements or additions to documentationImprovements or additions to documentationType: EnhancementNew feature or requestNew feature or request