Skip to main content

plugin-description

Ensure all JupyterFrontEndPlugin objects define a non-empty description property.

Examples​

Describe what the plugin provides​

Incorrect

const plugin: JupyterFrontEndPlugin<void> = {
  id: 'my-extension:commands',
  autoStart: true,
  activate: activateCommands
};

Correct

const plugin: JupyterFrontEndPlugin<void> = {
  id: 'my-extension:commands',
  description: 'Adds commands for exporting notebooks.',
  autoStart: true,
  activate: activateCommands
};

Replace an empty description​

Incorrect

const plugin: JupyterFrontEndPlugin<void> = {
  id: 'my-extension:preview',
  description: '',
  activate: activatePreview
};

Correct

const plugin: JupyterFrontEndPlugin<void> = {
  id: 'my-extension:preview',
  description: 'Provides a preview of the current document.',
  activate: activatePreview
};

Replace a whitespace-only description​

Incorrect

const plugin: JupyterFrontEndPlugin<void> = {
  id: 'my-extension:status',
  description: '   ',
  activate: activateStatus
};

Correct

const plugin: JupyterFrontEndPlugin<void> = {
  id: 'my-extension:status',
  description: 'Shows the current kernel status.',
  activate: activateStatus
};

Why​

A description tells maintainers and integrators what a plugin does without requiring them to read its activation code. Use a short, meaningful description; an empty or whitespace-only string is also reported.

Options​

This rule has no options.