Skip to content

Feature: Diagnostic documenation #232

@kobebryant432

Description

@kobebryant432

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

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions