Modiefies text to address specifics of Ruby naming convetions instead of Python.

Author: bendelonlee

ruby/README.md

@@ -1,33 +1,29 @@
-# Python Naming Convention
+# Ruby Naming Convention
 
-The style guide for Python is based on [Guido’s ](https://www.python.org/doc/essays/styleguide/)naming convention recommendations.
+The style guide for Ruby is based on [Guido’s ](https://www.Ruby.org/doc/essays/styleguide/)naming convention recommendations.
 
 List of covered sections:
 
-* [Class Naming](../python/class-naming.md)
-* [Constant Naming](../python/constant-naming.md)
-* [Method Naming](../python/method-naming.md)
-* [Module Naming](../python/module-naming.md)
-* [Variable Naming](../python/variable-naming.md)
-* [Package Naming](../python/package-naming.md "Python Package Naming")
-* [Exception Naming](../python/exception-naming.md)
-* [Underscore](../python/underscore.md)
+* [Class Naming](../Ruby/class-naming.md)
+* [Constant Naming](../Ruby/constant-naming.md)
+* [Module Naming](../Ruby/file-naming.md)
+* [Method Naming](../Ruby/method-naming.md)
+* [Package Naming](../Ruby/module-naming.md)
+* [Variable Naming](../Ruby/variable-naming.md)
 
 #### TL;DR
 
-| Type | Public | Internal |
-| :--- | :--- | :--- |
-| Packages | `lower_with_under` |  |
-| Modules | `lower_with_under` | `_lower_with_under` |
-| Classes | `CapWords` | `_CapWords` |
-| Exceptions | `CapWords` |  |
-| Functions | `lower_with_under()` | `_lower_with_under()` |
-| Global/Class Constants | `CAPS_WITH_UNDER` | `_CAPS_WITH_UNDER` |
-| Global/Class Variables | `lower_with_under` | `_lower_with_under` |
-| Instance Variables | `lower_with_under` | `_lower_with_under` |
-| Method Names | `lower_with_under()` | `_lower_with_under()` |
-| Function/Method Parameters | `lower_with_under` |  |
-| Local Variables | `lower_with_under` |  |
+| Type | Convention |
+| :--- | :--- |
+| Files | `lower_with_under` |  
+| Modules | `CapWords`|
+| Classes | `CapWords` |
+| Functions | `lower_with_under()` |
+| Global/Class Constants | `CAPS_WITH_UNDER` |
+| Global/Class Variables | `lower_with_under` |
+| Instance Variables | `lower_with_under` |
+| Method Names | `lower_with_under()` |
+| Function/Method Parameters | `lower_with_under` |
+| Local Variables | `lower_with_under` |
 
 Missing something? Please contribute here by reading [this guide](../docs/CONTRIBUTING.md).
-

ruby/class-naming.md

@@ -1,11 +1,16 @@
+<<<<<<< Updated upstream
 # Python Naming Convention > Class Naming
+=======
+# Ruby Naming Convention > Class Naming
+>>>>>>> Stashed changes
 
 ## PascalCase
 
 * Begin with an uppercase letter
 * Preferably a noun e.g. Car, Bird, MountainBike
 * Avoid acronyms and abbreviations
 
+<<<<<<< Updated upstream
 ```python
 class Car:
     ...
@@ -25,3 +30,9 @@ class _Car: # private class
 
 
 
+=======
+```ruby
+class Car
+    ...
+```
+>>>>>>> Stashed changes

ruby/constant-naming.md

@@ -1,15 +1,26 @@
+<<<<<<< Updated upstream
 # Python Naming Convention > Constant Naming
+=======
+# Ruby Naming Convention > Constant Naming
+>>>>>>> Stashed changes
 
 ## SCREAMING_SNAKE_CASE
 
 * Should be all uppercase letters e.g. AGE, HEIGHT
 * If the name contains multiple words, it should be separated by underscores (_) such as DAYS_IN_MONTH
 * May contain digits but not as the first letter
 
+<<<<<<< Updated upstream
 ```python
 class Product:
     MAX_TEMPERATURE = 36;
 ```
 
 
 
+=======
+```ruby
+class Product
+    MAX_TEMPERATURE = 36;
+```
+>>>>>>> Stashed changes

ruby/exception-naming.md

@@ -1,11 +1,16 @@
+<<<<<<< Updated upstream
 # Python module Convention > Package Naming
+=======
+# Ruby module Convention > File Naming
+>>>>>>> Stashed changes
 
 ## snake_case
 
 * Should be in lowercase.
 * If the name contains multiple words, an underscore (_) should separate it.E.g. expression_engine
 * The name should resonate with the class or methods inside the module
 
+<<<<<<< Updated upstream
 ```python
 from math import factorial
 class Car:
@@ -14,3 +19,10 @@ class Car:
 
 
 
+=======
+```ruby
+require './application_record'
+class Car
+    ...
+```
+>>>>>>> Stashed changes

ruby/file-naming.md

@@ -1,10 +1,15 @@
+<<<<<<< Updated upstream
 # Python Naming Convention > Method Naming
+=======
+# Ruby Naming Convention > Method Naming
+>>>>>>> Stashed changes
 
 ## snake_case
 
 * Should be all in lowercase
 * Preferably a verb e.g. get_car(), purchase(), book()
 * If the name contains multiple words, it should be separated by underscores \(\_\) e.g. get\_json\(\)
+<<<<<<< Updated upstream
 
 ```python
 class Person:
@@ -28,3 +33,36 @@ class Person:
 
 
 
+=======
+* Clear and descriptive method names without abbreviations are preferred.
+
+```ruby
+class Person
+    def get_height(self)
+        return self.height
+    end
+end
+```
+
+## Private methods
+
+To make a method private, use the keyword `private` above it anywhere in the class.
+
+```ruby
+class Person
+
+    def get_height(self)
+        return self.height
+    end
+
+    private
+
+    def get_weight(self)
+        return self.height
+    end
+
+end
+```
+
+Above, `get_height()` is public, `get_weight()` is private. You may use the `public` key word below `private`, but generally this is not done.
+>>>>>>> Stashed changes

ruby/method-naming.md

@@ -1,12 +1,11 @@
-# Python module Convention > Module Naming
+# Ruby Naming Convention > Module Naming
 
-## snake_case
-- Should be all in lowercase letters such as requests, math
-- If contains multiple words, it should be separated by underscores (_) e.g. expression_engine.py
-- Should resonate with the class or methods inside the module
+## PascalCase
+- Adjoining capitalized words
+- Should resonate with the classes or methods inside the module
 
-```python
-from math import factorial
-class Car:
-    ...
+```ruby
+
+module ApplicationHelper
+end
 ```

ruby/module-naming.md

@@ -1,11 +1,16 @@
+<<<<<<< Updated upstream
 # Python Naming Convention > Variable Naming
+=======
+# Ruby Naming Convention > Variable Naming
+>>>>>>> Stashed changes
 
 ## snake_case
 
 * Should be all in lowercase
 * Not begin with the special characters like e.g. & (ampersand), $ (dollar)
 * If the name contains multiple words, it should be separated by underscores (_) e.g. json_string
 * Avoid one-character variables e.g. a, b
+<<<<<<< Updated upstream
 
 ```python
 class Student
@@ -29,3 +34,24 @@ class Student:
 
 
 
+=======
+* Clear and descriptive variable names without abbreviations are preferred.
+
+```ruby
+  first_name = "Hanz"
+```
+
+The above is an example of a local variable.
+
+Instance variables are prefixed with an '@' and are used in Ruby classes as show below.
+
+
+```ruby
+class Student
+    def initialize(name)
+      @name = name
+    end
+```
+
+Other prefixes include '$' for global variables, and '@@' for class variables. But when possible, instance and local variables are preferred. 
+>>>>>>> Stashed changes