documinty 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e847137dcc7a46903f7339d096678c5a07c32413e8877830ba496c6e1325e9e7
-  data.tar.gz: 5672e3ce3188e413bbc292bfe457deb90af10ba22a3ec8b8a9dbeb28635b2aba
+  metadata.gz: 9cdaaaa7ee632437dcc089dff1519f0ed89d221455ec410e5774d4b5f065e33d
+  data.tar.gz: 2b59162f6da06d1ab50a2065096a96588343c13481e2cf0f8ea14ed0666145e8
 SHA512:
-  metadata.gz: '0859bd3be39d71225c6a04577062a93b5d3411fb237a6c1de93467e78dc74b8b27fefba48908914a52d92385efbc11086479580ed9c2de51a7e23e1579264c83'
-  data.tar.gz: 4f55d997b8b3a5a1261985830c169b7fb0bf8bdf9c42346c3f5482c492bde72ac0ccc3c7ad6f6deff1b5ea5a0a6cf819b61776db2ed0a68a8aa7f31b21f4623f
+  metadata.gz: 6b88c14ac88e558f2e70d345a48a0c2870052857def3e9de9ba18c44f1b0d58c03bf56add9761fd02d6d81fbd7e59e1a3684fc499cb30976f65d362aee374c40
+  data.tar.gz: a9999e6a85bba70df3388e5d4f37e522ab7d67f24113f5ba33cda215bea161941940d54c3c922db4470346251b4c93dfdc863c02eedf5275c7fc9c8a2bac0deb

data/README.md

@@ -22,7 +22,7 @@ Everything you record lives under a `.documinty/` folder in your project. You ca
 
 ### From RubyGems
 
-```bash
+```
 gem install documinty
 # or, if you prefer the short alias:
 # gem install dty
@@ -74,23 +74,55 @@ dty doc app/controllers/sessions_controller.rb -f user-auth -n controller
 ```
 dty show app/controllers/sessions_controller.rb
 ```
+
+Show documentation under a specific feature
+```
+dty show app/controllers/sessions_controller.rb -f user-auth
+```
 ### 6. List all defined features
 ```
 dty features
 ```
 ### 7. Show all files under "user-auth"
 ```
-dty list_f user-auth
+dty show_feature user-auth
 ```
 ### 8. Show file structure under "user-auth"
 ```
-dty involved_f user-auth
+dty involved user-auth
 ```
 ### 9. Search for features that contain "user"
 ```
 dty search_f user
 ```
+### 10. Add or remove methods for a documented file
+To add:
+```
+dty methods path/to/file -f user-auth -a add
+```
+
+To add:
+```
+dty methods path/to/file -f user-auth -a remove
+```
+you will be prompted to add the comma separated methods that you want to add or remove
+### 11. Display description of a documented file
+```
+dty describe path/to/file
+```
+This will display all the descriptions that a file has undear each of the features
+
+Optionally, the feature flag can be passed to specify the description for  a feature
+```
+dty describe path/to/file -f user-auth
+```
+### 12. Update the description for a file 
+```
+dty update_description path/to/file -f user-auth
+```
+NOTE: you must pass the feature when updating the description
 
+You will be prompted to enter the new description for the file under the feature
 ### Project layout
 ```
 .

data/lib/documinty/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Documinty
-  VERSION = "0.3.2"
+  VERSION = "0.3.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: documinty
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Marcel Carrero Pedre