martha 0.0.0 → 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +10 -6
- data/lib/martha/version.rb +1 -1
- data/martha.gemspec +2 -3
- metadata +3 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 32be982b109d0a45f08abc0a5005707574d96e10
|
|
4
|
+
data.tar.gz: b7a87437035957afcdcb52b4846c20b5c3ff589a
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 61d99cbfb204c1e76cbc5a6fbf35e02594f0e169359812d2cef843fde4973ebd21d9fa76b6888fc6771909ee93a77de373a028435523975f39482fbb63879282
|
|
7
|
+
data.tar.gz: a61a010ebcfb5d176fe339979fad4d0000ef3f1f551b09f558ad3785fe147e7e61ffa6e518caa43085b990bcc851f00805f561a76dcffa78ca8abcd1775b07e7
|
data/README.md
CHANGED
|
@@ -7,6 +7,7 @@ Gem that documents code/software for a better organisation and understanding of
|
|
|
7
7
|
- [What it actually do?](#what-it-actually-do)
|
|
8
8
|
- [Contributing](#contributing)
|
|
9
9
|
- [Credits](#author-and-contributor-list)
|
|
10
|
+
- [Issues](#issues)
|
|
10
11
|
|
|
11
12
|
## Installation
|
|
12
13
|
Pre-install:
|
|
@@ -20,11 +21,11 @@ To install the gem you can just run the following command:
|
|
|
20
21
|
## What it actually do?
|
|
21
22
|
Command:
|
|
22
23
|
```console
|
|
23
|
-
% martha
|
|
24
|
+
% martha reveal <NAME_FILE>
|
|
24
25
|
```
|
|
25
26
|
And your code is documented. Easy
|
|
26
27
|
|
|
27
|
-
Programming
|
|
28
|
+
Programming Languages Supported:
|
|
28
29
|
- Ruby
|
|
29
30
|
- C++
|
|
30
31
|
|
|
@@ -33,15 +34,18 @@ Programming Lenguages Supported:
|
|
|
33
34
|
You only need to use the martha command:
|
|
34
35
|
|
|
35
36
|
```console
|
|
36
|
-
% martha
|
|
37
|
+
% martha reveal <NAME_FILE>
|
|
37
38
|
```
|
|
38
39
|
|
|
40
|
+
## Issues
|
|
41
|
+
- The gem recognizes when a function was commented whit the special characters ("//Function") next to the headers. If you delete this, the function will write a new comment under of the old comment.
|
|
42
|
+
|
|
39
43
|
## Contributing
|
|
40
44
|
Everyone is freely to collaborate and submit pull request if needed.
|
|
41
|
-
You can add more support for new programming
|
|
45
|
+
You can add more support for new programming languages.
|
|
42
46
|
|
|
43
47
|
##Author and Contributor List
|
|
44
48
|
-------------------
|
|
45
|
-
- Victor Elizalde
|
|
49
|
+
- Victor Hugo Elizalde Muñoz
|
|
46
50
|
- Oscar Michel Herrera
|
|
47
|
-
- Mauricio Cortés
|
|
51
|
+
- Mauricio Iván Cortés García
|
data/lib/martha/version.rb
CHANGED
data/martha.gemspec
CHANGED
|
@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
|
|
|
8
8
|
spec.version = Martha::VERSION
|
|
9
9
|
spec.authors = ['Victor Elizalde', 'Mauricio Cortes', 'Oscar Michel']
|
|
10
10
|
spec.email = ['vic-bull@hotmail.com']
|
|
11
|
-
spec.summary = 'A ruby gem to
|
|
12
|
-
spec.description = 'A ruby gem to
|
|
11
|
+
spec.summary = 'A ruby gem to document code (Check github repo for specifications)'
|
|
12
|
+
spec.description = 'A ruby gem to document code (Check github repo for specifications).'
|
|
13
13
|
spec.homepage = 'https://github.com/VictorElizalde/Martha'
|
|
14
14
|
spec.license = 'MIT'
|
|
15
15
|
spec.executables << "martha"
|
|
@@ -27,6 +27,5 @@ Gem::Specification.new do |spec|
|
|
|
27
27
|
spec.add_development_dependency 'pry'
|
|
28
28
|
spec.add_development_dependency 'rubocop'
|
|
29
29
|
spec.add_development_dependency 'reek'
|
|
30
|
-
|
|
31
30
|
spec.add_dependency 'thor'
|
|
32
31
|
end
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: martha
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.0.
|
|
4
|
+
version: 0.0.1
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Victor Elizalde
|
|
@@ -110,7 +110,7 @@ dependencies:
|
|
|
110
110
|
- - ">="
|
|
111
111
|
- !ruby/object:Gem::Version
|
|
112
112
|
version: '0'
|
|
113
|
-
description: A ruby gem to
|
|
113
|
+
description: A ruby gem to document code (Check github repo for specifications).
|
|
114
114
|
email:
|
|
115
115
|
- vic-bull@hotmail.com
|
|
116
116
|
executables:
|
|
@@ -155,5 +155,5 @@ rubyforge_project:
|
|
|
155
155
|
rubygems_version: 2.5.1
|
|
156
156
|
signing_key:
|
|
157
157
|
specification_version: 4
|
|
158
|
-
summary: A ruby gem to
|
|
158
|
+
summary: A ruby gem to document code (Check github repo for specifications)
|
|
159
159
|
test_files: []
|