.. CS116 documentation master file, created by
   sphinx-quickstart on Mon Mar  4 10:37:08 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Word
====

A Word object contains text from a string.


Example Usage
-------------

.. code:: python
   
   # Create a new Word object.
   word = Word('Hello!')
   
   # Store a reversed copy of the word.
   reversedWord = word.reverse()
   
   # This prints '!olleH'.
   print(reversedWord)


Initialization
--------------

.. py:function:: Word.Word(self, str)
   
   :param string str: the word.
   
.. code:: python

   word = Word('Hello')

Getters
-------

Get the string form of the word.

.. py:function:: Word.getLetters(self)

.. code:: python

   word.getLetters()

Methods
-------

Return the reversed form of the word as a string.

.. py:function:: Word.reverse(self)

.. code:: python

   reversedWord = word.reverse()

