<commit_before>.. _guide-updating-to-1.0:

===============
Updating to 1.0
===============

What's new?
=================

* Added **Multipage** support, which introduces a new way to analyze documents (see `Partial and Composite documents`_ section below).
* Updated **Bolts** to 1.9 (see more details `here <https://github.com/BoltsFramework/Bolts-ObjC/blob/master/CHANGELOG.md>`_)
* Now it is possible to provide a cancellation token for every task

Partial and Composite documents
=================

Now - for every page - a **Partial** document has to be created using the
`createPartialDocumentWithFilename:fromData:docType:cancellationToken:` method, even if only one page is going to be analyzed.
Once you have created one or several partial documents, you have to create a **Composite** document. To do so, you just need to pass an array of `GINIPartialDocumentInfo` (in the correct order) to the `createCompositeDocumentWithPartialDocumentsInfo:fileName:docType:cancellationToken:`` method.

Finally, you can get the extractions for that **Composite** document using the `getExtractionsForDocument:` method in the `GINIDocumentTaskManager`.

Breaking changes
=================
<commit_msg>Fixed documentation issue<commit_after>.. _guide-updating-to-1.0:

===============
Updating to 1.0
===============

What's new?
=================

* Added **Multipage** support, which introduces a new way to analyze documents (see [Partial and Composite documents](##partial-and-composite-documents) section below).
* Updated **Bolts** to 1.9 (see more details [here](https://github.com/BoltsFramework/Bolts-ObjC/blob/master/CHANGELOG.md))
* Now it is possible to provide a cancellation token for every task

Partial and Composite documents
=================

Now - for every page - a **Partial** document has to be created using the
`createPartialDocumentWithFilename:fromData:docType:cancellationToken:` method, even if only one page is going to be analyzed.
Once you have created one or several partial documents, you have to create a **Composite** document. To do so, you just need to pass an array of `GINIPartialDocumentInfo` (in the correct order) to the `createCompositeDocumentWithPartialDocumentsInfo:fileName:docType:cancellationToken:`` method.

Finally, you can get the extractions for that **Composite** document using the `getExtractionsForDocument:` method in the `GINIDocumentTaskManager`.

Breaking changes
=================

{'fraction_non_alphanumeric': 0.14455364455364456, 'fraction_numerical': 0.004914004914004914, 'mean_word_length': 6.0, 'pattern_counts': {'":': 0, '<': 4, '<?xml version=': 0, '>': 4, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1781619', 'n_tokens_mistral': 651, 'n_tokens_neox': 638, 'n_words': 261}