comment cleanup

packages/grafana-ui/src/types/panel.ts

@@ -27,10 +27,15 @@ export interface PanelEditorProps<T = any> {
 }
 
 /**
- * Checks the existing model before the component is loaded
+ * This function is called with the full panelModel before
- * This is useful for fixing options as configuration changes
+ * the pluginPanel is constructed.  This gives you an opportunity
- * The object passed in is the panel model.... but not typed
+ * to validate the panel settings before the panel loads.
- * since that is not in grafana ui
+ *
+ * @param panelModel the whole panel object.  including the configuration
+ * saved for other panels
+ *
+ * @returns the validated panel options that will be passed into the
+ * panel constructor
  */
 export type PanelOptionsValidator<T = any> = (panelModel: any) => T;
 

public/app/features/dashboard/dashgrid/DashboardPanel.tsx

@@ -96,7 +96,8 @@ export class DashboardPanel extends PureComponent<Props, State> {
     }
   }
 
-  // This is be called before the plugin constructor, so the initial properties are valid
+  // This is called before the plugin is added to the three,
+  // it allows plugins to update options before loading
   validateOptions = (plugin: PanelPlugin, panel: PanelModel) => {
     const { reactPanel } = plugin.exports;
     if (reactPanel && reactPanel.optionsValidator) {