diff --git a/README.md b/README.md index 0ee4048b..ce28dea7 100644 --- a/README.md +++ b/README.md @@ -137,18 +137,17 @@ Documentation is a work-in-progress. ## Background -These stubs are the result of a strategic effort lead by the core pandas team to integrate [Microsoft type stub repository](https://github.com/microsoft/python-type-stubs) -together with the [VirtusLabs pandas_stubs repository](https://github.com/VirtusLab/pandas-stubs). +These stubs are the result of a strategic effort led by the core pandas team to integrate [Microsoft type stub repository](https://github.com/microsoft/python-type-stubs) with the [VirtusLabs pandas_stubs repository](https://github.com/VirtusLab/pandas-stubs). -These stubs were initially forked from the Microsoft project as of [this commit](https://github.com/microsoft/python-type-stubs/tree/6b800063bde687cd1846122431e2a729a9de625a). +These stubs were initially forked from the Microsoft project at as of [this commit](https://github.com/microsoft/python-type-stubs/tree/6b800063bde687cd1846122431e2a729a9de625a). -We are indebted to Microsoft and that project for the initial set of public type stubs. We are also grateful for the original pandas-stubs project at that created the framework for testing the stubs. +We are indebted to Microsoft and that project for providing the initial set of public type stubs. We are also grateful for the original pandas-stubs project at , which created the framework for testing the stubs. ## Differences between type declarations in pandas and pandas-stubs The project has type declarations for some parts of pandas, both for the internal and public API's. Those type declarations are used to make sure that the pandas code is _internally_ consistent. -The project provides type declarations for the pandas _public_ API. The philosophy of these stubs can be found at While it would be ideal if the `pyi` files in this project would be part of the `pandas` distribution, this would require consistency between the internal type declarations and the public declarations, and the scope of a project to create that consistency is quite large. That is a long term goal. Finally, another goal is to do more frequent releases of the pandas-stubs than is done for pandas, in order to make the stubs more useful. +The project provides type declarations for the pandas _public_ API. The philosophy of these stubs can be found at . While it would be ideal if the `pyi` files in this project would be part of the `pandas` distribution, this would require consistency between the internal type declarations and the public declarations, and the scope of a project to create that consistency is quite large. That is a long term goal. Finally, another goal is to do more frequent releases of the pandas-stubs than is done for pandas, in order to make the stubs more useful. If issues are found with the public stubs, pull requests to correct those issues are welcome. In addition, pull requests on the pandas repository to fix the same issue are welcome there as well. However, since the goals of typing in the two projects are different (internal consistency vs. public usage), it may be a challenge to create consistent type declarations across both projects. See for a discussion of typing standards used within the pandas code.