Some docstrings for PyGMT and GMT modules use plural first person when describing what the function does (e.g "we create labels" in grd2cpt, "we will write a GeoTiff image" in grdimage). Personally, I'm not a fan of this, as there is no "we" doing the operations; it's PyGMT/GMT that is carrying them out. While I don't think any users would misinterpret this as the PyGMT team doing the work behind-the-scenes, I still think the docstrings should be changed to accurately portray who or what is making assumptions and running calculations. Should I submit a PR with changes for these types of docstrings?
This originally came up in my comment for project.
Examples:
color_model in grd2cpt
Old
If *label* is appended then we create labels for each category to be used when the CPT is plotted.
New
Append *label* to create labels for each category to be used when the CPT is plotted.
nearest_multiple in grdinfo
Old
We report the result via the text string *zmin/zmax* or *zmin/zmax/dz*
New
The result is returned in the text string format *zmin/zmax* or *zmin/zmax/dz*
Are you willing to help implement and maintain this feature? Yes
Some docstrings for PyGMT and GMT modules use plural first person when describing what the function does (e.g "we create labels" in
grd2cpt, "we will write a GeoTiff image" ingrdimage). Personally, I'm not a fan of this, as there is no "we" doing the operations; it's PyGMT/GMT that is carrying them out. While I don't think any users would misinterpret this as the PyGMT team doing the work behind-the-scenes, I still think the docstrings should be changed to accurately portray who or what is making assumptions and running calculations. Should I submit a PR with changes for these types of docstrings?This originally came up in my comment for
project.Examples:
color_modelingrd2cptOld
New
nearest_multipleingrdinfoOld
New
Are you willing to help implement and maintain this feature? Yes