Create I Best Practices.py

Author: ortizfram

Writing Functions in Python/I Best Practices.py

@@ -0,0 +1,34 @@
+"""**************************************************************************************************************************************************************
+goal of this course is to transform you into a Python expert, and so the first chapter starts off with best practices when writing functions.
+You'll cover docstrings and why they matter and how to know when you need to turn a chunk of code into a function. You will also learn the details of how Python passes 
+
+Docstrings
+==========
+- makes your code easier to use, read, maintain
+
+    @ anatomy of docstring
+    -----------------------
+      def func_name(arguments):
+        '''
+         Description of what it does 
+         Description of argument(s) if any
+         Description of return value(s) if any
+         Description of errors raised if any
+         Optional extra notes or examples
+         '''
+    @ docstring Formats
+    -----------------------     
+    - Google style (pupular)  - NumpyDoc (popular)  - reStructuredText    - EpyText
+    
+      ----Google style === straight to the point eg. '''Stack the columns''' and just Arg:, Raises: , Returns: , Notes:
+      ----NumpyDoc     === more vertical with line tittles, takes more space
+      
+    @ Review Documentation
+    -----------------------
+    >>>>>>>> func_name.__doc__ ====review documentation
+    >>>>>>>> .getdoc(dunc_name) (inspect module)
+    
+        ++
+            import inspect
+            print(inspect.getdoc(func_name))
+**************************************************************************************************************************************************************"""