diff --git a/docs/index.md b/docs/index.md index 5e11145..9076076 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,7 +4,7 @@ Impresso Project Logo

-Impresso is a library to interact with the [Impresso](https://impresso-project.ch/app) dataset. It provides a set of classes to interact with the API and a set of tools that make working with the data easier. +Impresso is a library designed to facilitate interaction with the [Impresso](https://impresso-project.ch/app) dataset. It offers a comprehensive set of classes for API interaction and a variety of tools to streamline data manipulation and analysis. ## Installation and prerequisites @@ -14,7 +14,7 @@ The Impresso python library can be installed using `pip`: pip install impresso ``` -The library requires Python version `3.10` as a minimum. It has a number of dependencies that are likely already present in a Jupyter environment like `matplotlib` and `pandas`. +The library requires Python version `3.10` or higher. It also depends on several packages commonly found in Jupyter environments, such as `matplotlib` and `pandas`. ## Create a session diff --git a/docs/preparing_queries.md b/docs/preparing_queries.md index 3e6721b..4ab7988 100644 --- a/docs/preparing_queries.md +++ b/docs/preparing_queries.md @@ -1,9 +1,9 @@ # Preparing queries -Some filter parameters accept a combination of modifiers that can be used to create complex queries. For example, if we want to search for a term `Titanic` and `ship`, we can use the `AND` modifier to combine the two conditions: +Some filter parameters accept a combination of modifiers to create complex queries. For example, to search for content that mentions both `Titanic` and `ship`, you can use the `AND` modifier to combine these conditions: ```python -from impresso import AND, OR +from impresso import AND impresso.search.find(term=AND("Titanic", "ship")) ``` diff --git a/docs/result.md b/docs/result.md index 7aa6b66..7a8e88f 100644 --- a/docs/result.md +++ b/docs/result.md @@ -1,7 +1,7 @@ # Result object -Every time you run a query, you get a `DataContainer` object. This object contains the results of the query and some metadata about the query. It also contains a collection of utility methods that you can use to access the result in different ways. +When you execute a query, a `DataContainer` object is returned. This object encapsulates the query results along with metadata about the query. Additionally, it provides a suite of utility methods for accessing the results in various ways. -When the `DataContainer` object is used in a Python notebook environment, it can render itself as a preview of the data it contains. This is useful for quickly inspecting the results of a query. +In a Python notebook environment, the `DataContainer` object can render a preview of its data, facilitating quick inspection of the query results. ::: impresso.data_container.DataContainer