Skip to content

Commit 59cfb9e

Browse files
DOC- Let Copilot suggest documentation improvements (skrub-data#1902)
1 parent 519b909 commit 59cfb9e

8 files changed

Lines changed: 24 additions & 24 deletions

File tree

CHANGES.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Release history
99
Ongoing Development
1010
===================
1111

12-
New features
12+
New Features
1313
------------
1414
- The ``eager_data_ops`` :ref:`configuration
1515
<user_guide_configuration_parameters>` option has been added. When set to
@@ -23,8 +23,8 @@ New features
2323
Changes
2424
-------
2525

26-
Bugfixes
27-
--------
26+
Bug Fixes
27+
---------
2828

2929
Release 0.7.2
3030
=============

CONTRIBUTING.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Contributing guide
44
==================
55

6-
First off, thanks for taking the time to contribute!
6+
First off, thank you for taking the time to contribute!
77

88
Below are some guidelines to help you get started.
99

@@ -20,7 +20,7 @@ What to know before you begin
2020
-----------------------------
2121

2222
To understand the purpose and goals behind skrub, please read our
23-
`vision statement. <https://skrub-data.org/stable/vision.html>`_
23+
`vision statement <https://skrub-data.org/stable/vision.html>`_.
2424

2525
If you're interested in the research behind skrub,
2626
we encourage you to explore these papers:

README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,10 @@ skrub
1818

1919

2020
**skrub** (formerly *dirty_cat*) is a Python
21-
library that facilitates doing machine learning with dataframes.
21+
library that facilitates machine learning with dataframes.
2222

2323
If you like the package, spread the word and ⭐ this repository!
24-
You can also join the `discord server <https://discord.gg/ABaPnm7fDC>`_.
24+
You can also join the `Discord server <https://discord.gg/ABaPnm7fDC>`_.
2525

2626
Website: https://skrub-data.org/
2727

RELEASE_PROCESS.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ conda-forge project page.
1919
the last stable version. These releases are numbered X.Y.Z.
2020

2121
To release a new minor version of skrub (e.g., from 0.1.0 to 0.2.0), here are the main
22-
steps and appropriate resources: the main steps and appropriate resources:
22+
steps and appropriate resources:
2323

2424
Preparing the release branch
2525
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

doc/about.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ skrub shares much of its DNA with `scikit-learn
66
<https://scikit-learn.org>`__.
77

88
skrub is the continuation of `dirty-cat <http://dirty-cat.github.io>`_
9-
with a broader scope and a broader ambition.
9+
with a broader scope and greater ambition.
1010

11-
skrub is a fairly young project born from research. We are happy to get feedback
12-
on successes and failures with the different techniques on real world data, or
13-
learn about open datasets on which we can do better examples and empirical work.
11+
skrub is a young project born from research. We welcome feedback
12+
on successes and failures with the different techniques on real-world data, or
13+
suggestions for open datasets on which we can do better examples and empirical work.
1414

1515
skrub received funding from French research projects: `DirtyData
1616
<https://project.inria.fr/dirtydata/>`_ (ANR-17-CE23-0018), `LearnI
17-
<https://anr.fr/Projet-ANR-20-CHIA-0026>`_ (ANR-20-CHIA-0026) and `P16
17+
<https://anr.fr/Projet-ANR-20-CHIA-0026>`_ (ANR-20-CHIA-0026), and `P16
1818
<https://p16.inria.fr/fr/>`_.

doc/development.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
Development
44
===========
55

6-
While ``skrub`` is still being born, we believe in openness and community
7-
development from the start. Join us in building a great package to
6+
While ``skrub`` is still in its early stages, we believe in openness and
7+
community development from the start. Join us in building a great package to
88
facilitate learning on databases.
99

1010
.. include:: includes/big_toc_css.rst

doc/documentation.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ User Guide
44
==========
55

66
Skrub is a Python library that facilitates machine learning with tabular data
7-
(dataframes, as with pandas and polars) using a scikit-learncompatible API.
7+
(dataframes, such as pandas and polars) using a scikit-learn-compatible API.
88

99
Use the sections below to navigate the guide. For runnable code, see the
1010
:doc:`Example gallery <auto_examples/index>`. For class and function details, see

doc/vision.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
11
===============================
2-
Vision: where is skrub heading?
2+
Vision: Where is skrub heading?
33
===============================
44

55
.. currentmodule:: skrub
66

7-
Vision statement
7+
Vision Statement
88
================
99

1010
The goal of skrub is to facilitate machine learning on tables:
1111
`pandas <https://pandas.pydata.org>`__
12-
and `polars <https://pola.rs>`__ dataframes, SQL databases...
12+
and `polars <https://pola.rs>`__ dataframes, SQL databases, and more.
1313

1414
|
1515
16-
Skrub is high-level, with a philosophy and an API matching that of
16+
Skrub is high-level, with a philosophy and API matching that of
1717
`scikit-learn <http://scikit-learn.org>`_. It strives to bridge the world
18-
of databases to that of machine-learning, **enabling imperfect assembly and
19-
representations of the data when it is noisy**, using the downstream
20-
target to predict to guide assembly when possible (supervised learning for
18+
of databases and machine learning, **enabling imperfect assembly and
19+
representation of data when it is noisy**, using the downstream
20+
target to guide assembly when possible (supervised learning for
2121
data assembly).
2222

2323
In the long term, as skrub is built on higher-level APIs, it will make it
24-
easier for data-scientists to use efficient database patterns and
24+
easier for data scientists to use efficient database patterns and
2525
backends.
2626

2727
Skrub seeks tradeoffs in terms of flexibility: its high-level APIs are by

0 commit comments

Comments
 (0)