dnote 1.1.3 → 1.1.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. data/README.rdoc +13 -15
  2. data/lib/dnote/notes.rb +1 -1
  3. data/meta/version +1 -1
  4. metadata +12 -5
data/README.rdoc CHANGED
@@ -7,7 +7,7 @@
7
7
 
8
8
  == DESCRIPTION
9
9
 
10
- Extract developement notes from source code and generate some nice
10
+ Extract development notes from source code and generate some nice
11
11
  output formats for them.
12
12
 
13
13
 
@@ -15,11 +15,11 @@ output formats for them.
15
15
 
16
16
  === Note Structure
17
17
 
18
- D'Note scans for the common noting pattern used by develepors of many laguages of an all-caps label
19
- followed bt a colon. To be more specific, for D'Note to recogznie a note, it needs ot follow this
20
- simple set of rules:
18
+ D'Note scans for the common note patterns used by developers of many languages in the form of an
19
+ all-caps labels followed by a colon. To be more specific, for D'Note to recognize a note,
20
+ it needs to follow this simple set of rules:
21
21
 
22
- 1) Notes start with an all-caps label puctuated with a colon, followed by the note's text.
22
+ 1) Notes start with an all-caps label punctuated with a colon, followed by the note's text.
23
23
 
24
24
  # LABEL: description ...
25
25
 
@@ -35,21 +35,21 @@ the note for a <tt>&lt;pre&gt;</tt> block if it is indented.
35
35
  # LABEL: description ...
36
36
  # continue ...
37
37
 
38
- 4) An alternative to the limitation of the last rule is to indent the whole note, making it
39
- a <tt>&lt;pre&gt;</tt> block. Then the text layout is free-form.
38
+ 4) An alternative to the previous limitation is to indent the whole note, making it
39
+ a <tt>&lt;pre&gt;</tt> block when rendered by RDoc. Then the text layout is free-form.
40
40
 
41
41
  # This is a description of something...
42
42
  #
43
43
  # LABEL: description ...
44
44
  # continue ...
45
45
 
46
- That's all there is to it, if I can convince the developers of RDoc to add recognize labels,
47
- we may eventually be able to relax the flush rule, which would be very nice.
46
+ That's all there is to it, if I can convince the developers of RDoc to recognize labels,
47
+ we may eventually be able to relax the flush rule too, which would be very nice.
48
48
 
49
49
 
50
50
  === Generating Notes
51
51
 
52
- As you can see the commandline interface is quite straight-forward.
52
+ As you can see the commandline interface is pretty straight-forward.
53
53
 
54
54
  Usage: dnote [OPTIONS] path1 [path2 ...]
55
55
 
@@ -70,7 +70,7 @@ As you can see the commandline interface is quite straight-forward.
70
70
  --debug debug mode
71
71
  -h, --help show this help information
72
72
 
73
- The default path is <tt>**/*.rb</tt> and the default format <tt>--rdoc</tt>.
73
+ The default path is <tt>**/*.rb</tt> and the default format is <tt>--rdoc</tt>.
74
74
  Here is an example of DNote's current notes in RDoc format:
75
75
 
76
76
  = Development Notes
@@ -79,7 +79,7 @@ Here is an example of DNote's current notes in RDoc format:
79
79
 
80
80
  === file://lib/dnote/notes.rb
81
81
 
82
- * TODO: Add ability to read header notes. They oftern
82
+ * TODO: Add ability to read header notes. They often
83
83
  have a outline format, rather then the single line. (19)
84
84
  * TODO: Need good CSS file. (22)
85
85
  * TODO: Need XSL? (24)
@@ -91,10 +91,9 @@ Here is an example of DNote's current notes in RDoc format:
91
91
  (4 TODOs)
92
92
 
93
93
 
94
-
95
94
  == INSTALLATION
96
95
 
97
- The usual RubyGem's command:
96
+ The usual RubyGem's command will do the trick.
98
97
 
99
98
  $ sudo gem install dnote
100
99
 
@@ -107,4 +106,3 @@ Copyright (c) 2006, 2009 Thomas Sawyer
107
106
 
108
107
  THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
109
108
 
110
-
data/lib/dnote/notes.rb CHANGED
@@ -124,7 +124,7 @@ module DNote
124
124
  )
125
125
  end
126
126
 
127
- #
127
+ # TODO: ruby-1.9.1-p378 reports: notes.rb:131:in `match': invalid byte sequence in UTF-8
128
128
  def match_common(line, lineno, file)
129
129
  rec = nil
130
130
  labels.each do |label|
data/meta/version CHANGED
@@ -1 +1 @@
1
- 1.1.3
1
+ 1.1.4
metadata CHANGED
@@ -1,7 +1,12 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: dnote
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.1.3
4
+ prerelease: false
5
+ segments:
6
+ - 1
7
+ - 1
8
+ - 4
9
+ version: 1.1.4
5
10
  platform: ruby
6
11
  authors:
7
12
  - Thomas Sawyer
@@ -9,7 +14,7 @@ autorequire:
9
14
  bindir: bin
10
15
  cert_chain: []
11
16
 
12
- date: 2010-02-07 00:00:00 -05:00
17
+ date: 2010-02-12 00:00:00 -05:00
13
18
  default_executable:
14
19
  dependencies: []
15
20
 
@@ -64,18 +69,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
64
69
  requirements:
65
70
  - - ">="
66
71
  - !ruby/object:Gem::Version
72
+ segments:
73
+ - 0
67
74
  version: "0"
68
- version:
69
75
  required_rubygems_version: !ruby/object:Gem::Requirement
70
76
  requirements:
71
77
  - - ">="
72
78
  - !ruby/object:Gem::Version
79
+ segments:
80
+ - 0
73
81
  version: "0"
74
- version:
75
82
  requirements: []
76
83
 
77
84
  rubyforge_project: dnote
78
- rubygems_version: 1.3.5
85
+ rubygems_version: 1.3.6.pre.2
79
86
  signing_key:
80
87
  specification_version: 3
81
88
  summary: Extract developer notes from source code.