Add docstrings to BMI classes

csdms / bmi-example-python

An example of wrapping a model written in Python with a BMI

https://bmi.csdms.io

MIT License

13 stars 22 forks source link

Add docstrings to BMI classes #1

Closed mdpiper closed 9 years ago

mdpiper commented 9 years ago

The bulk of the changes in this pull request are the addition of numpydoc docstrings to the methods of the BMI classes, following the instructions in the guide.

I also:

moved get_var_rank to get_grid_rank
moved get_var_size to get_grid_size
added the get_var_grid method
changed the input parameter for the get_grid_* methods to grid_id, from long_var_name
updated the BmiHeat class and all the unit tests that use these methods

mcflugen commented 9 years ago

get_grid_rank and get_grid_size should accept a grid id rather than a long var name.

coveralls commented 9 years ago

Coverage remained the same at 100.0% when pulling b96e69848bcc37d7bdebed982543fa7df24f57fc on mdpiper:master into 38aa4c61903315ac0d8c369df8395b5ee9cc8a71 on csdms:master.

mdpiper commented 9 years ago

One problem: changing get_grid_rank and get_grid_size will break BmiHeat and the unit tests until the get_var_grid method is implemented. (Currently, it has only an interface in Bmi.)

landscape-bot commented 9 years ago

Repository health decreased by 0.55% when pulling b96e698 on mdpiper:master into 38aa4c6 on csdms:master.

1 new problem was found (including 0 errors and 1 code smell).
No problems were fixed.

mcflugen commented 9 years ago

I merged the documentation into master so that we had some documentation on our readthedocs page. Please submit a new PR with fixes to the get_grid_rank and get_grid_size functions and their unit tests.