Describe your changes in detail
Why is this change required? What problem does it solve? If it fixes an open issue, please link to the issue here.
Please describe in detail how you tested your changes. Include details of your testing environment, and the tests you ran to see how your change affects other areas of the code, etc.
What types of changes does your code introduce? Put an x
in all the boxes that apply:
- Bug fix (non-breaking change which fixes an issue)
- New feature (non-breaking change which adds functionality)
- Breaking change (fix or feature that would cause existing functionality to change)
Go over all the following points, and put an x
in all the boxes that apply.
If you're unsure about any of these, don't hesitate to ask. We're here to help!
- My code follows the code style of this project.
- My change requires a change to the documentation.
- I have updated the documentation accordingly.
- I have read the CONTRIBUTING document.