DOC: ecosystem pandas-stubs information #43207
Conversation
zkrolikowski-vl
changed the title
zkrolikowski-vl
changed the title
zkrolikowski-vl
changed the title
There was a problem hiding this comment.
Looks good, couple of ideas:
Maybe instead of a section Type stubs that it's likely to never have anything more than this project, a section development tools (or a similar name) could be used. I know there were some interest in a package for pandas stuff for users of certain IDEs. I think having those together could make sense.
Then, I wonder if having a usage example would help more than this technical information. It's clear to me, but I wonder if many of our users are not familiar with type annotations, and it won't be immediately obvious what this means. It's a personal opinion, and you can surely disagree with, but I feel like providing a short sentence saying that pandas-stubs enables type checking in pandas should be enough. If then we just have an example of installing with pip/conda, a sample file using pandas with annotations, and a call to mypy (maybe a call with and without installing pandas-stubs.
In any case, happy to get it merged like this too.
|
Decided to make some changes based on your feedback:
|
zkrolikowski-vl
force-pushed
the
doc/ecosystem_pandas_stubs
branch
2 times, most recently
from
52fd713 to
a767611
Compare
|
@datapythonista Do I have to take some action for the CI to pass? It times-out after an hour. |
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
I have just restarted CI now. Hopefully should run to completion this time |
|
pre-commit raises errors. You should fix them first |
doc/source/ecosystem.rst
Outdated
| `pandas-stubs <https://github.com/VirtusLab/pandas-stubs>`__ | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| pandas doesn't expose any type information to the user by itself. |
There was a problem hiding this comment.
this is not true there is lots of type information, explain how this is different.
There was a problem hiding this comment.
is this better? While pandas repository is partially typed, the package itself doesn't expose this information for external use.
web/pandas/community/ecosystem.md
Outdated
| @@ -388,3 +388,65 @@ authors to coordinate on the namespace. | |||
| | [pint-pandas](https://github.com/hgrecco/pint-pandas) | `pint` | `Series`, `DataFrame` | | |||
| | [composeml](https://github.com/alteryx/compose) | `slice` | `DataFrame` | | |||
| | [woodwork](https://github.com/alteryx/woodwork) | `slice` | `Series`, `DataFrame` | | |||
|
|
|||
There was a problem hiding this comment.
If you mean the empty line I removed it. I'm using Unix line endings.
|
I will get around to fixing the pre-commit issues locally. |
zkrolikowski-vl
force-pushed
the
doc/ecosystem_pandas_stubs
branch
from
7f03a5b to
045e19f
Compare
|
thanks @zkrolikowski-vl |
Added information about pandas-stubs to both the .rst and .md ecosystem doc files.
closes #43197