Amy/docs

[amytangzheng]

Pull Request Template:
If you are merging in a feature or other major change, use this template to check your pull request!

Basic Info

What's this pull request about?

My PR is about Adding or Improving Documentation.

My PR Adds or Improves Documentation

If your feature is about documentation, ensure that you check the boxes relevant to you.

Docstrings

• Docstrings: I have followed the proper documentation format (https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html; Google Format recommended).
• Docstrings: Every function in the file has a block quote comment with a description of the feature.
• Docstrings: Every input argument is documented.
• Docstrings: The output type is documented, along with a description of what the output is for.
• Docstrings: I have linked the feature under the Table of Contents (docs/source/features/index.rst)

Feature Wiki

• Conceptual Wiki: I made a copy of the TEMPLATE (docs/source/features_conceptual/TEMPLATE.rst)
• Conceptual Wiki: I replaced the word TEMPLATE at the top of the file with the name of the feature (.. _TEMPLATE:) Please do NOT delete any of the punctuation (the .._ and :) in the header, as this is important for referencing the feature in the Table of Contents!
• Conceptual Wiki: I have answered the six sections of the template to the best of my ability.
• Conceptual Wiki: I have linked the feature under the Table of Contents (docs/source/features_conceptual/index.rst).

General Documentation

• My documentation is linked in a toctree.
• I have confirmed that make clean and make html do not generate breaking errors.

My PR is About Adding a New Feature to the Code Repository

Documentation

Did you document your feature? You should follow the same requirements as above:

• Docstrings: I have followed the proper documentation format (https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html; Google Format recommended).
• Docstrings: Every function in the file has a block quote comment with a description of the feature.
• Docstrings: Every input argument is documented.
• Docstrings: The output type is documented, along with a description of what the output is for.
• Docstrings: I have linked the feature under the Table of Contents (docs/source/features/index.rst)

Code Basics

• My feature is a .py file.
• My feature uses snake case in the name. That means the name of the format is my_feature, NOT myFeature (camel case).
• My feature has the name, NAME_features.py, where NAME is the name of my feature.
• My feature is located in feature_engine/features/.

Testing

• I have thought about test cases for my features, with inputs and expected outputs.
• I have added test cases for my feature under the testing/ folder.
• My feature passes the automated testing suite.

The location of my tests are here:

[PASTE LINK HERE]

If you check all the boxes above, then you ready to merge!