Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

style incompatibility #46

Open
bradfordcondon opened this issue Jan 28, 2019 · 1 comment
Open

style incompatibility #46

bradfordcondon opened this issue Jan 28, 2019 · 1 comment

Comments

@bradfordcondon
Copy link
Member

bradfordcondon commented Jan 28, 2019

The drupal code sniffer reformats the static variable documentation and its kind of not good.

  • can we use @see like we do for the method definitions?
  • if not, what should we do?
    • remove the comments and perhaps put @see at the top of the class?
    • reformat the comments to follow the Drupal style standard?
@bradfordcondon bradfordcondon self-assigned this Jan 28, 2019
@bradfordcondon
Copy link
Member Author

heres what i mean. you can see that the multiline comments have the last line converted to /** style.

  // Provide a list of instance specific settings. These can be access within
  // the instanceSettingsForm.  When the instanceSettingsForm is submitted
  // then Drupal with automatically change these settings for the instnace.
  // It is recommended to put settings at the instance level whenever possible.
  // If you override this variable in a child class be sure to replicate the
  // term_name, term_vocab, term_accession and term_fixed keys as these are.
  /**
   * Required for all TripalFields.
   */
  public static $default_instance_settings = array(
    // The short name for the vocabulary (e.g. shcema, SO, GO, PATO, etc.).
    'term_vocabulary' => 'data',
    // The name of the term.
    'term_name' => 'protein_sequence',
    // The unique ID (i.e. accession) of the term.
    'term_accession' => '2976',
    // Set to TRUE if the site admin is allowed to change the term
    // type. This will create form elements when editing the field instance
    // to allow the site admin to change the term settings above.
    'term_fixed' => FALSE,
  );

  // Indicates the download formats for this field.  The list must be the.
  /**
   * Name of a child class of the TripalFieldDownloader.
   */
  public static $download_formatters = array(
    'TripalTabDownloader',
    'TripalCSVDownloader',
    'TripalProteinFASTADownloader',
  );

  /**
   * The default widget for this field.
   */
  public static $default_widget = 'data__protein_sequence_widget';

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant