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

We encourage users to post events happening in the community to the community events group on https://www.drupal.org.
pillarsdotnet's picture

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

Comments

Hi - I'm just wondering why

arianek's picture

Hi - I'm just wondering why this wasn't filed as an issue... it looks like it should be (?)

Yes, these cross-postings are

sun's picture

Yes, these cross-postings are confusing.

However, the end of this post links to the existing issue: http://drupal.org/node/1298304

Daniel F. Kudwien
netzstrategen

Was confused, just realizing

arianek's picture

Was confused, just realizing what is going on here...

@pillarsdotnet - it's really confusing when you post issues to g.d.o (and also divides the conversation into two places, which is not beneficial).

If you must post to g.d.o to bring attention to issues, please just post a brief intro (not the entire issue summary) and a link to the issue, and remind people to comment on the actual issue. (But I'd recommend that this is limited to only very critical issues as it really confuses things, clutters up g.d.o with threads that are already in the issue queue, and links/issue references will break...)

Thanks!

Coding standards

Group organizers

Group categories

Status

Group notifications

This group offers an RSS feed. Or subscribe to these personalized, sitewide feeds:

Hot content this week