IBM/simulai

Add Docstrings to Simulation, Normalization, Metrics, and Mesh Modules

TarikKaanKoc opened this issue · 1 comments

Currently, the Simulation, Normalization, Metrics, and Mesh modules in our codebase lack docstrings. Docstrings are essential for documenting the purpose, inputs, outputs, and usage of functions and classes. They provide a quick reference for other developers to understand and use the code. Therefore, it's important to have docstrings for all public functions and classes in our modules.

This issue is to add numpy-style docstrings to the public functions and classes in the Simulation, Normalization, Metrics, and Mesh modules. The docstrings should follow the numpydoc format and include the following sections:

  • Summary: A brief one-line summary of the function/class.
  • Parameters: Description of each parameter with its type, name, and description.
  • Returns: Description of the return value with its type and description.
  • Raises: Description of the exceptions that can be raised.
  • Examples: Examples of how to use the function/class.

We need to add docstrings to the following modules:

  • Simulation
  • Normalization
  • Metrics
  • Mesh

Thank you for your contribution!

That is alright, @TarikKaanKoc. Thank you.