Skip to content

Commit db89d8e

Browse files
trentrichardsontrentrichardson
committed
Clean up docs and readme
1 parent 867bcec commit db89d8e

6 files changed

+36
-43
lines changed

‎CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@ Assuming that you don't see any red, you're ready to go. Just be sure to run `gr
2222

2323
## Submitting pull requests
2424

25-
1. Create a new branch, please don't work in your `master` branch directly.
25+
1. Create a new branch, please don't work in your `master` branch directly. Please pull from the `dev` branch.
2626
1. Add failing tests for the change you want to make. Run `grunt` to see the tests fail.
2727
1. Fix stuff.
2828
1. Run `grunt` to see if the tests pass. Repeat steps 2-4 until done.
2929
1. Open `test/*.html` unit test file(s) in actual browser to ensure tests pass everywhere.
3030
1. Update the documentation to reflect any changes.
31-
1. Push to your fork and submit a pull request.
31+
1. Push to your fork and submit a pull request (back to the `dev` branch).

‎dist/index.html

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -127,8 +127,7 @@ <h3>Version</h3>
127127
<p>Version 1.3.2</p>
128128

129129
<p>Last updated on 07/07/2013</p>
130-
<p>jQuery Timepicker Addon is currently available for use in all personal or commercial projects under both MIT and GPL licenses. This means that you can choose the license that best suits your project, and use it accordingly. </p>
131-
<p><a href="http://trentrichardson.com/Impromptu/GPL-LICENSE.txt" title="GPL License">GPL License</a></p>
130+
<p>jQuery Timepicker Addon is currently available for use in all personal or commercial projects under the MIT license.</p>
132131
<p><a href="http://trentrichardson.com/Impromptu/MIT-LICENSE.txt" title="MIT License">MIT License</a></p>
133132

134133
</div>
@@ -218,15 +217,15 @@ <h3>Time Field Options</h3>
218217
<dt>controlType</dt>
219218
<dd><em>Default: 'slider'</em> - Whether to use 'slider' or 'select'. If 'slider' is unavailable through jQueryUI, 'select' will be used. For advanced usage you may pass an object which implements "create", "options", "value" methods to use controls other than sliders or selects. See the _controls property in the source code for more details.
220219
<pre>{
221-
create: function(tp_inst, obj, unit, val, min, max, step){
222-
// generate whatever controls you want here, just return obj
223-
},
224-
options: function(tp_inst, obj, unit, opts, val){
225-
// if val==undefined return the value, else return obj
226-
},
227-
value: function(tp_inst, obj, unit, val){
228-
// if val==undefined return the value, else return obj
229-
}
220+
create: function(tp_inst, obj, unit, val, min, max, step){
221+
// generate whatever controls you want here, just return obj
222+
},
223+
options: function(tp_inst, obj, unit, opts, val){
224+
// if val==undefined return the value, else return obj
225+
},
226+
value: function(tp_inst, obj, unit, val){
227+
// if val==undefined return the value, else return obj
228+
}
230229
}</pre>
231230
</dd>
232231

@@ -374,12 +373,12 @@ <h3>Other Options</h3>
374373
<dt>parse</dt>
375374
<dd><em>Default: 'strict'</em> - How to parse the time string. Two methods are provided: 'strict' which must match the timeFormat exactly, and 'loose' which uses javascript's new Date(timeString) to guess the time. You may also pass in a function(timeFormat, timeString, options) to handle the parsing yourself, returning a simple object:
376375
<pre>{
377-
hour: 19,
378-
minute: 10,
379-
second: 23,
380-
millisec: 45,
381-
microsec: 23,
382-
timezone: '-0400'
376+
hour: 19,
377+
minute: 10,
378+
second: 23,
379+
millisec: 45,
380+
microsec: 23,
381+
timezone: '-0400'
383382
}</pre>
384383
</dd>
385384
</dl>

‎dist/jquery-ui-timepicker-addon.js

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
/*! jQuery Timepicker Addon - v1.3.2 - 2013-07-29
22
* http://trentrichardson.com/examples/timepicker
33
* Copyright (c) 2013 Trent Richardson; Licensed MIT */
4-
/*jslint evil: true, white: false, undef: false */
5-
64
(function ($) {
75

86
/*

‎src/docs/intro.html

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,7 @@ <h3>Version</h3>
5252
<p>Version 1.3.2</p>
5353

5454
<p>Last updated on 07/07/2013</p>
55-
<p>jQuery Timepicker Addon is currently available for use in all personal or commercial projects under both MIT and GPL licenses. This means that you can choose the license that best suits your project, and use it accordingly. </p>
56-
<p><a href="http://trentrichardson.com/Impromptu/GPL-LICENSE.txt" title="GPL License">GPL License</a></p>
55+
<p>jQuery Timepicker Addon is currently available for use in all personal or commercial projects under the MIT license.</p>
5756
<p><a href="http://trentrichardson.com/Impromptu/MIT-LICENSE.txt" title="MIT License">MIT License</a></p>
5857

5958
</div>

‎src/docs/options.html

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -83,15 +83,15 @@ <h3>Time Field Options</h3>
8383
<dt>controlType</dt>
8484
<dd><em>Default: 'slider'</em> - Whether to use 'slider' or 'select'. If 'slider' is unavailable through jQueryUI, 'select' will be used. For advanced usage you may pass an object which implements "create", "options", "value" methods to use controls other than sliders or selects. See the _controls property in the source code for more details.
8585
<pre>{
86-
create: function(tp_inst, obj, unit, val, min, max, step){
87-
// generate whatever controls you want here, just return obj
88-
},
89-
options: function(tp_inst, obj, unit, opts, val){
90-
// if val==undefined return the value, else return obj
91-
},
92-
value: function(tp_inst, obj, unit, val){
93-
// if val==undefined return the value, else return obj
94-
}
86+
create: function(tp_inst, obj, unit, val, min, max, step){
87+
// generate whatever controls you want here, just return obj
88+
},
89+
options: function(tp_inst, obj, unit, opts, val){
90+
// if val==undefined return the value, else return obj
91+
},
92+
value: function(tp_inst, obj, unit, val){
93+
// if val==undefined return the value, else return obj
94+
}
9595
}</pre>
9696
</dd>
9797

@@ -239,12 +239,12 @@ <h3>Other Options</h3>
239239
<dt>parse</dt>
240240
<dd><em>Default: 'strict'</em> - How to parse the time string. Two methods are provided: 'strict' which must match the timeFormat exactly, and 'loose' which uses javascript's new Date(timeString) to guess the time. You may also pass in a function(timeFormat, timeString, options) to handle the parsing yourself, returning a simple object:
241241
<pre>{
242-
hour: 19,
243-
minute: 10,
244-
second: 23,
245-
millisec: 45,
246-
microsec: 23,
247-
timezone: '-0400'
242+
hour: 19,
243+
minute: 10,
244+
second: 23,
245+
millisec: 45,
246+
microsec: 23,
247+
timezone: '-0400'
248248
}</pre>
249249
</dd>
250250
</dl>

‎src/jquery-ui-timepicker-addon.js

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,9 @@
11
/*
2-
* jQuery timepicker addon
2+
* jQuery Timepicker Addon
33
* By: Trent Richardson [http://trentrichardson.com]
4-
* Version 1.3.2-dev
5-
* Last Modified: 07/07/2013
64
*
75
* Copyright 2013 Trent Richardson
8-
* You may use this project under MIT or GPL licenses.
9-
* http://trentrichardson.com/Impromptu/GPL-LICENSE.txt
6+
* You may use this project under MIT license.
107
* http://trentrichardson.com/Impromptu/MIT-LICENSE.txt
118
*/
129

0 commit comments

Comments
 (0)