Quantcast
Viewing latest article 6
Browse Latest Browse All 22

Identify and document externally-developed files which should not be changed to conform to Drupal coding standards.

Problem/Motivation

There are externally-developed files, such as misc/jquery.js and module/system/system.tar.inc that should not be updated to meet Drupal coding standards.

Every few months, however, someone comes along and submits an issue to apply current coding standards to these files, which wastes time and energy for all concerned.

Proposed resolution

  • Externally-developed files should be identified somehow, perhaps in the @file header.
  • The API module should be updated to recognize these deliberately non-standards-compliant files, so that it can exclude them from the usual parsing requirements.
  • This should be documented somewhere in the Coding standards.

Remaining tasks

  • Decide how to tag externally-developed files.
  • Modify the Coding standards to note that they exist and how to identify them.
  • Modify the API module to recognize and exclude (or at least visibly distinguish) externally-developed files.

User interface changes

Someone browsing api.drupal.org should be able to identify which source files are externally-developed and therefore deliberately not in conformance with Drupal coding standards.

API changes

None.

Original report by [username]

Coming here from [#1295510] which wasted braincells re-considering an issue that was apparently decided in [#870204].

Further discussion at http://drupal.org/node/1298304


Viewing latest article 6
Browse Latest Browse All 22

Trending Articles