Docstrings.

coderanger · coderanger · commit 18807e5ccc8e · 2015-08-15T23:33:49.000-07:00
diff --git a/lib/poise_application_python/app_mixin.rb b/lib/poise_application_python/app_mixin.rb
@@ -14,38 +14,52 @@
 # limitations under the License.
 #
 
-require 'chef/mash'
 require 'poise/backports'
 require 'poise/utils'
 require 'poise_application/app_mixin'
 require 'poise_python/python_command_mixin'
 
 
 module PoiseApplicationPython
+  # A helper mixin for Python application resources and providers.
+  #
+  # @since 4.0.0
   module AppMixin
     include Poise::Utils::ResourceProviderMixin
 
+    # A helper mixin for Python application resources.
     module Resource
       include PoiseApplication::AppMixin::Resource
       include PoisePython::PythonCommandMixin::Resource
 
+      # @!attribute parent_python
+      #   Override the #parent_python from PythonCommandMixin to grok the
+      #   application level parent as a default value.
+      #   @return [PoisePython::Resources::PythonRuntime::Resource, nil]
       parent_attribute(:python, type: :python_runtime, optional: true, default: lazy { app_state_python.equal?(self) ? nil : app_state_python })
 
       # @attribute app_state_python
+      #   The application-level Python parent.
+      #   @return [PoisePython::Resources::PythonRuntime::Resource, nil]
       def app_state_python(python=Poise::NOT_PASSED)
         unless python == Poise::NOT_PASSED
           app_state[:python] = python
         end
         app_state[:python]
       end
 
+      # A merged hash of environment variables for both the application state
+      # and parent python.
+      #
+      # @return [Hash<String, String>]
       def app_state_environment_python
         env = app_state_environment
         env = env.merge(parent_python.python_environment) if parent_python
         env
       end
     end
 
+    # A helper mixin for Python application providers.
     module Provider
       include PoiseApplication::AppMixin::Provider
     end
