issue_comments: 674583004
This data as json
| html_url | issue_url | id | node_id | user | created_at | updated_at | author_association | body | reactions | performed_via_github_app | issue |
|---|---|---|---|---|---|---|---|---|---|---|---|
| https://github.com/pydata/xarray/issues/4345#issuecomment-674583004 | https://api.github.com/repos/pydata/xarray/issues/4345 | 674583004 | MDEyOklzc3VlQ29tbWVudDY3NDU4MzAwNA== | 14371165 | 2020-08-16T21:57:36Z | 2020-08-16T22:02:34Z | MEMBER | Creating a decorator for this sounds a bit too fancy compared to just moving the init docstring to the class docstring in my opinion. Is xarray following the numpy docstring guidelines? Reading up on the numpy guidelines they recommend that the constructor (init) should be documented at the class docstring. https://numpydoc.readthedocs.io/en/latest/format.html#class-docstring And after looking around some more the modules that prefers having init parameters at the class docstring are: * numpy - https://github.com/numpy/numpy/blob/master/numpy/core/records.py#L98 * scipy - https://github.com/scipy/scipy/blob/v1.5.2/scipy/interpolate/interpolate.py * pandas - https://github.com/pandas-dev/pandas/blob/v1.1.0/pandas/core/frame.py#L339-L9257 * dask - https://github.com/dask/dask/blob/master/dask/blockwise.py#L135 |
{
"total_count": 0,
"+1": 0,
"-1": 0,
"laugh": 0,
"hooray": 0,
"confused": 0,
"heart": 0,
"rocket": 0,
"eyes": 0
} |
679575175 |