# {py:mod}`arelle.CompareInstance`

```{py:module} arelle.CompareInstance
```

```{autodoc2-docstring} arelle.CompareInstance
:allowtitles:
```

## Module Contents

### Functions

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`_factFootnotes <arelle.CompareInstance._factFootnotes>`
  - ```{autodoc2-docstring} arelle.CompareInstance._factFootnotes
    :summary:
    ```
* - {py:obj}`_compareInstance <arelle.CompareInstance._compareInstance>`
  - ```{autodoc2-docstring} arelle.CompareInstance._compareInstance
    :summary:
    ```
* - {py:obj}`compareInstance <arelle.CompareInstance.compareInstance>`
  - ```{autodoc2-docstring} arelle.CompareInstance.compareInstance
    :summary:
    ```
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`_ <arelle.CompareInstance._>`
  - ```{autodoc2-docstring} arelle.CompareInstance._
    :summary:
    ```
````

### API

````{py:data} _
:canonical: arelle.CompareInstance._
:type: arelle.typing.TypeGetText
:value: >
   None

```{autodoc2-docstring} arelle.CompareInstance._
```

````

````{py:function} _factFootnotes(fact: arelle.ModelInstanceObject.ModelFact, footnotesRelSet: arelle.ModelRelationshipSet.ModelRelationshipSet) -> dict[str, str]
:canonical: arelle.CompareInstance._factFootnotes

```{autodoc2-docstring} arelle.CompareInstance._factFootnotes
```
````

````{py:function} _compareInstance(originalInstance: arelle.ModelXbrl.ModelXbrl, expectedInstance: arelle.ModelXbrl.ModelXbrl, targetInstance: arelle.ModelXbrl.ModelXbrl, matchById: bool) -> None
:canonical: arelle.CompareInstance._compareInstance

```{autodoc2-docstring} arelle.CompareInstance._compareInstance
```
````

````{py:function} compareInstance(modelManager: arelle.ModelManager.ModelManager, originalInstance: arelle.ModelXbrl.ModelXbrl, targetInstance: arelle.ModelXbrl.ModelXbrl, expectedInstanceUri: str, errorCaptureLevel: int, matchById: bool) -> arelle.ErrorManager.ErrorsType
:canonical: arelle.CompareInstance.compareInstance

```{autodoc2-docstring} arelle.CompareInstance.compareInstance
```
````