-
Notifications
You must be signed in to change notification settings - Fork 3
Code Documentation
Eugen Kuksa edited this page Aug 29, 2016
·
1 revision
Write a Readme.md in the directory of a gem or into a directory of a component that describes the purpose and the control flow of the component.
- Write a short description of a class or module at the top of the class/module definition.
- Write a short description of a method if it is complex and/or the name of the method does not describe its purpose. Avoid method names that do not describe the purpose in the first place.
The short description does not have to be rdoc. Instead, write a complete sentence.