DOC: improvements to inline docs/comments#619
DOC: improvements to inline docs/comments#619theroggy wants to merge 6 commits intogeopandas:mainfrom
Conversation
There was a problem hiding this comment.
@theroggy thanks for working on the docs!
To be fair, I would personally not put too much effort in listing every parameter in the internal docs (when it is often not much more as repeating the type that is also in the signature, mostly in _io.pyx), but adding the short summary lines is definitely a nice improvement (and since you already did the work, I won't further complain about it ;))
pyogrio/_vsi.pyx
Outdated
| Path or BytesIO object that you would like to write to. If a BytesIO | ||
| object is passed, a temporary in-memory vsimem file will be created for you | ||
| to write to. |
There was a problem hiding this comment.
FWIW, given this function is an internal helper function, and this content is already in the extended summary above, I am not sure about the value of repeating it here (just duplication that can get out of sync?)
pyogrio/_io.pyx
Outdated
| ogr_layer : OGRLayerH | ||
| The open OGR layer | ||
| skip_features : int | ||
| The number of features to skip from the beginning of the layer |
There was a problem hiding this comment.
"beginning of the layer" is misleading here (compared to "available range" what was written before), since this might not actually be the beginning of the layer if another filter is applied
pyogrio/_io.pyx
Outdated
| n_fields : int | ||
| The number of fields in the feature | ||
| field_data : object | ||
| The array where field data is stored |
pyogrio/_io.pyx
Outdated
| field_ogr_types : object | ||
| An array with the OGR types for each field | ||
| encoding : object | ||
| The encoding to use for reading field data |
There was a problem hiding this comment.
| The encoding to use for reading field data | |
| The encoding to use for reading string field data |
…nts-to-inline-docs/comments
2 participants
General improvements to mainly docstrings + add missing docstrings.