Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Properties incorrectly being marked as functions #1352

Closed
Tracked by #479
Eric-Arellano opened this issue May 13, 2024 · 0 comments · Fixed by #1387
Closed
Tracked by #479

Properties incorrectly being marked as functions #1352

Eric-Arellano opened this issue May 13, 2024 · 0 comments · Fixed by #1387

Comments

@Eric-Arellano
Copy link
Collaborator

After merging #1340, search for modifiers="property". I'm surprised those are being categorized as Functions rather than Attributes. I'd expect @property to show up in the Attributes section of classes.

github-merge-queue bot pushed a commit that referenced this issue May 15, 2024
…0.24-0.28 (#1387)

Closes #1352

We have 18989 misclassified properties across different versions of
Qiskit (0.24 - 0.28). To fix them, this PR added an early return to the
`getApiType()` to return the correct `apyType` in case a member has the
property modifier.

This is an example of the HTML of a property:

```html
<dl class="py method">
<dt id="qiskit.circuit.Measure.definition">
<em class="property">property </em><code class="sig-name descname">definition</code><a class="headerlink" href="#qiskit.circuit.Measure.definition" title="Permalink to this definition">¶</a></dt>
<dd><p>Return definition in terms of other basic gates.</p>
</dd></dl>
```

The script searches for the `property` modifier inside the `<dt>` tag
inside the `<dl>` tag.
frankharkins pushed a commit to frankharkins/documentation that referenced this issue Jul 22, 2024
…0.24-0.28 (Qiskit#1387)

Closes Qiskit#1352

We have 18989 misclassified properties across different versions of
Qiskit (0.24 - 0.28). To fix them, this PR added an early return to the
`getApiType()` to return the correct `apyType` in case a member has the
property modifier.

This is an example of the HTML of a property:

```html
<dl class="py method">
<dt id="qiskit.circuit.Measure.definition">
<em class="property">property </em><code class="sig-name descname">definition</code><a class="headerlink" href="#qiskit.circuit.Measure.definition" title="Permalink to this definition">¶</a></dt>
<dd><p>Return definition in terms of other basic gates.</p>
</dd></dl>
```

The script searches for the `property` modifier inside the `<dt>` tag
inside the `<dl>` tag.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
3 participants