Skip to content

Commit 5d5ea01

Browse files
authored
Docs: Replace #NUMBER Trac issue references with trac-NUMBER
The GitHub UI treats `#NUMBER` as referring to its own issues which is confusing when in jQuery source it's usually referring to the old deprecated Trac instance at https://bugs.jquery.com. This change replaces all such Trac references with `trac-NUMBER`. A few of the references came with the Sizzle integration and referred to the Sizzle GitHub bug tracker. Those have been replaced with full links instead. A new entry describing issue reference conventions has been added to README. Closes gh-4993
1 parent 655c0ed commit 5d5ea01

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+400
-390
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,12 @@ In the spirit of open source software development, jQuery always encourages comm
1414
2. [Core Style Guide](https://contribute.jquery.org/style-guide/js/)
1515
3. [Writing Code for jQuery Foundation Projects](https://contribute.jquery.org/code/)
1616

17+
### References to issues/PRs
18+
19+
GitHub issues/PRs are usually referenced via `gh-NUMBER`, where `NUMBER` is the numerical ID of the issue/PR. You can find such an issue/PR under `https://github.com/jquery/jquery/issues/NUMBER`.
20+
21+
jQuery has used a different bug tracker - based on Trac - in the past, available under [bugs.jquery.com](https://bugs.jquery.com/). It is being kept in read only mode so that referring to past discussions is possible. When jQuery source references one of those issues, it uses the pattern `trac-NUMBER`, where `NUMBER` is the numerical ID of the issue. You can find such an issue under `https://bugs.jquery.com/ticket/NUMBER`.
22+
1723

1824
Environments in which to use jQuery
1925
--------------------------------------

src/ajax.js

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ var
1717
rantiCache = /([?&])_=[^&]*/,
1818
rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg,
1919

20-
// #7653, #8125, #8152: local protocol detection
20+
// trac-7653, trac-8125, trac-8152: local protocol detection
2121
rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/,
2222
rnoContent = /^(?:GET|HEAD)$/,
2323
rprotocol = /^\/\//,
@@ -40,7 +40,7 @@ var
4040
*/
4141
transports = {},
4242

43-
// Avoid comment-prolog char sequence (#10098); must appease lint and evade compression
43+
// Avoid comment-prolog char sequence (trac-10098); must appease lint and evade compression
4444
allTypes = "*/".concat( "*" ),
4545

4646
// Anchor tag for parsing the document origin
@@ -111,7 +111,7 @@ function inspectPrefiltersOrTransports( structure, options, originalOptions, jqX
111111

112112
// A special extend for ajax options
113113
// that takes "flat" options (not to be deep extended)
114-
// Fixes #9887
114+
// Fixes trac-9887
115115
function ajaxExtend( target, src ) {
116116
var key, deep,
117117
flatOptions = jQuery.ajaxSettings.flatOptions || {};
@@ -528,12 +528,12 @@ jQuery.extend( {
528528
deferred.promise( jqXHR );
529529

530530
// Add protocol if not provided (prefilters might expect it)
531-
// Handle falsy url in the settings object (#10093: consistency with old signature)
531+
// Handle falsy url in the settings object (trac-10093: consistency with old signature)
532532
// We also use the url parameter if available
533533
s.url = ( ( url || s.url || location.href ) + "" )
534534
.replace( rprotocol, location.protocol + "//" );
535535

536-
// Alias method option to type as per ticket #12004
536+
// Alias method option to type as per ticket trac-12004
537537
s.type = options.method || options.type || s.method || s.type;
538538

539539
// Extract dataTypes list
@@ -605,7 +605,7 @@ jQuery.extend( {
605605
if ( s.data && ( s.processData || typeof s.data === "string" ) ) {
606606
cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data;
607607

608-
// #9682: remove data so that it's not used in an eventual retry
608+
// trac-9682: remove data so that it's not used in an eventual retry
609609
delete s.data;
610610
}
611611

src/ajax/xhr.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ jQuery.ajaxTransport( function( options ) {
6666
} else if ( type === "error" ) {
6767
complete(
6868

69-
// File: protocol always yields status 0; see #8605, #14207
69+
// File: protocol always yields status 0; see trac-8605, trac-14207
7070
xhr.status,
7171
xhr.statusText
7272
);
@@ -99,7 +99,7 @@ jQuery.ajaxTransport( function( options ) {
9999
xhr.send( options.hasContent && options.data || null );
100100
} catch ( e ) {
101101

102-
// #14683: Only rethrow if this hasn't been notified as an error yet
102+
// trac-14683: Only rethrow if this hasn't been notified as an error yet
103103
if ( callback ) {
104104
throw e;
105105
}

src/attributes/prop.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ jQuery.extend( {
6060
// elem.tabIndex doesn't always return the
6161
// correct value when it hasn't been explicitly set
6262
// https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/
63-
// Use proper attribute retrieval(#12072)
63+
// Use proper attribute retrieval (trac-12072)
6464
var tabindex = elem.getAttribute( "tabindex" );
6565

6666
if ( tabindex ) {

src/attributes/val.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ if ( isIE ) {
149149
val :
150150

151151
// Support: IE <=10 - 11+
152-
// option.text throws exceptions (#14686, #14858)
152+
// option.text throws exceptions (trac-14686, trac-14858)
153153
// Strip and collapse whitespace
154154
// https://html.spec.whatwg.org/#strip-and-collapse-whitespace
155155
stripAndCollapse( jQuery.text( elem ) );

src/core/init.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ import "../traversing/findFilter.js";
1010
var rootjQuery,
1111

1212
// A simple way to check for HTML strings
13-
// Prioritize #id over <tag> to avoid XSS via location.hash (#9521)
14-
// Strict HTML recognition (#11290: must start with <)
13+
// Prioritize #id over <tag> to avoid XSS via location.hash (trac-9521)
14+
// Strict HTML recognition (trac-11290: must start with <)
1515
// Shortcut simple #id case for speed
1616
rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/,
1717

src/core/ready-no-deferred.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ jQuery.extend( {
2525
isReady: false,
2626

2727
// A counter to track how many items to wait for before
28-
// the ready event fires. See #6781
28+
// the ready event fires. See trac-6781
2929
readyWait: 1,
3030

3131
ready: function( wait ) {

src/core/ready.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ jQuery.extend( {
2828
isReady: false,
2929

3030
// A counter to track how many items to wait for before
31-
// the ready event fires. See #6781
31+
// the ready event fires. See trac-6781
3232
readyWait: 1,
3333

3434
// Handle when the DOM is ready

src/css.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -220,15 +220,15 @@ jQuery.extend( {
220220
if ( value !== undefined ) {
221221
type = typeof value;
222222

223-
// Convert "+=" or "-=" to relative numbers (#7345)
223+
// Convert "+=" or "-=" to relative numbers (trac-7345)
224224
if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) {
225225
value = adjustCSS( elem, name, ret );
226226

227-
// Fixes bug #9237
227+
// Fixes bug trac-9237
228228
type = "number";
229229
}
230230

231-
// Make sure that null and NaN values aren't set (#7116)
231+
// Make sure that null and NaN values aren't set (trac-7116)
232232
if ( value == null || value !== value ) {
233233
return;
234234
}
@@ -239,7 +239,7 @@ jQuery.extend( {
239239
}
240240

241241
// Support: IE <=9 - 11+
242-
// background-* props of a cloned element affect the source element (#8908)
242+
// background-* props of a cloned element affect the source element (trac-8908)
243243
if ( isIE && value === "" && name.indexOf( "background" ) === 0 ) {
244244
style[ name ] = "inherit";
245245
}

src/css/cssCamelCase.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ var rmsPrefix = /^-ms-/;
66
// Convert dashed to camelCase, handle vendor prefixes.
77
// Used by the css & effects modules.
88
// Support: IE <=9 - 11+
9-
// Microsoft forgot to hump their vendor prefix (#9572)
9+
// Microsoft forgot to hump their vendor prefix (trac-9572)
1010
function cssCamelCase( string ) {
1111
return camelCase( string.replace( rmsPrefix, "ms-" ) );
1212
}

0 commit comments

Comments
 (0)