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.

Sign up for GitHub

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

Jump to bottom

API generation regression in properties #224

Closed
Eric-Arellano opened this issue Oct 20, 2023 · 3 comments · Fixed by #899
Closed

API generation regression in properties #224

Eric-Arellano opened this issue Oct 20, 2023 · 3 comments · Fixed by #899
Assignees
@arnaucasau
Labels
infra 🏗️
Milestone
24-03-01 runtime ...

Comments

@Eric-Arellano
Copy link
Collaborator

Eric-Arellano commented Oct 20, 2023 •
edited by frankharkins
Loading

From #222 (comment):

This is a regression.

Now:

Screenshot 2023-10-20 at 5 19 17 PM

Before:

Screenshot 2023-10-20 at 5 19 30 PM

qiskit.org:

Screenshot 2023-10-20 at 5 19 57 PM
@Eric-Arellano Eric-Arellano added this to the dec release milestone Oct 20, 2023
@Eric-Arellano Eric-Arellano self-assigned this Oct 20, 2023
This was referenced Oct 20, 2023
Merged
Closed
Eric-Arellano added a commit that referenced this issue Oct 24, 2023
@Eric-Arellano
Update Runtime API docs to 0.13 (#222)
d666b50 
Now that we fixed #67, we
can regenerate the API docs. The issues were due to changes with modern
Sphinx 7.2.

There was one regression I noticed, but it's not enough of a
show-stopper to block this PR:
#224.
@Eric-Arellano Eric-Arellano modified the milestones: dec release, Qiskit 1.0 Oct 24, 2023
@Eric-Arellano Eric-Arellano removed their assignment Nov 21, 2023
@Eric-Arellano Eric-Arellano mentioned this issue Jan 10, 2024
Closed
5 tasks
@frankharkins frankharkins mentioned this issue Jan 10, 2024
Merged
@frankharkins
Copy link
Member

Possibly related problem in /api/qiskit/tools#monitoring (see "line_discipline").

Screenshot 2024-01-25 at 12 03 44

@Eric-Arellano Eric-Arellano moved this to In Progress in Docs Planning Jan 26, 2024
@Eric-Arellano Eric-Arellano removed the status in Docs Planning Feb 9, 2024
@arnaucasau arnaucasau mentioned this issue Feb 27, 2024
Merged
@arnaucasau
Copy link
Collaborator

@frankharkins I think the issue with line_discipline is not related to this regression. It seems like the HTML files from the CI artifact have the same problem 🤔

Captura desde 2024-02-27 20-53-14

@frankharkins
Copy link
Member

Good spot! In that case I think we can ignore the line_discipline issue as it's pretty minor and the "tools" module doesn't exist in Qiskit 1.x

github-merge-queue bot pushed a commit that referenced this issue Feb 28, 2024
@arnaucasau
Fix API generation regression (#899)
8158062 
Closes #224

This PR fixes an issue with the API generation script that causes
regressions in attributes. For each attribute, we show on the
documentation website, its type (if exists) and its default value (if
exists).

An example of an attribute could be `instance: str | None = None` which
has the type `str | None` and the default value `None`. This is its
representation on the website:

![Captura desde 2024-02-27
19-12-42](https://github.com/Qiskit/documentation/assets/47946624/e2cce336-9d0a-4da7-bd80-3f7d7cf1f6c4)

To find the attribute and the default value, the script searches for the
index of the colon (type separator) and the index of the equal sign
(default value separator). The problem is that those two values are
optional, and we could have, for example, a default value involving a
string containing a colon symbol that would be detected as the type
separator when it's not.

To fix this, we could only search for the type separator before the
default value. We don't have any problem with the equal sign because it
cannot be a type of attribute.

The PR has regenerated all versions of qiskit, runtime, and provider.
frankharkins pushed a commit to frankharkins/documentation that referenced this issue Jul 22, 2024
@Eric-Arellano
Update Runtime API docs to 0.13 (Qiskit#222)
2fdcc70 
Now that we fixed Qiskit#67, we
can regenerate the API docs. The issues were due to changes with modern
Sphinx 7.2.

There was one regression I noticed, but it's not enough of a
show-stopper to block this PR:
Qiskit#224.
frankharkins pushed a commit to frankharkins/documentation that referenced this issue Jul 22, 2024
@arnaucasau
Fix API generation regression (Qiskit#899)
d0d4392 
Closes Qiskit#224

This PR fixes an issue with the API generation script that causes
regressions in attributes. For each attribute, we show on the
documentation website, its type (if exists) and its default value (if
exists).

An example of an attribute could be `instance: str | None = None` which
has the type `str | None` and the default value `None`. This is its
representation on the website:

![Captura desde 2024-02-27
19-12-42](https://github.com/Qiskit/documentation/assets/47946624/e2cce336-9d0a-4da7-bd80-3f7d7cf1f6c4)

To find the attribute and the default value, the script searches for the
index of the colon (type separator) and the index of the equal sign
(default value separator). The problem is that those two values are
optional, and we could have, for example, a default value involving a
string containing a colon symbol that would be detected as the type
separator when it's not.

To fix this, we could only search for the type separator before the
default value. We don't have any problem with the equal sign because it
cannot be a type of attribute.

The PR has regenerated all versions of qiskit, runtime, and provider.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@arnaucasau arnaucasau

Labels
infra 🏗️
Projects
Docs Planning
Archived in project
Milestone
24-03-01 runtime primitives release
Development

Successfully merging a pull request may close this issue.

Fix API generation regression arnaucasau/documentation
4 participants
@Eric-Arellano @javabster @frankharkins @arnaucasau