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

Remove signature for the Attribute component #1291

Merged
merged 1 commit into from
May 3, 2024

Conversation

arnaucasau
Copy link
Collaborator

@arnaucasau arnaucasau commented May 3, 2024

This PR removes the signature prop from the Attribute component and instead, sets attributeTypeHint and attributeValue. This change simplifies the script that was using different props for attributes embedded in the class page and the rest.

As a side effect, this PR also fixes an issue with some default values not showing correctly. These values were treated as signatures and wrongly converted into HTML by a unified plugin.

Closes #1217 #1252

Copy link
Collaborator

@Eric-Arellano Eric-Arellano left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👏 did you try regenerating the other APIs to confirm this does not unintentionally change them?

@arnaucasau arnaucasau marked this pull request as ready for review May 3, 2024 12:16
@arnaucasau arnaucasau changed the title [WIP] Remove signature for the Attribute component Remove signature for the Attribute component May 3, 2024
@qiskit-bot
Copy link
Contributor

Thanks for contributing to Qiskit documentation!

Before your PR can be merged, it will first need to pass continuous integration tests and be reviewed. Sometimes the review process can be slow, so please be patient. Thanks! 🙌

@arnaucasau
Copy link
Collaborator Author

Yeah, I ran the regen-apis command after, and no other APIs were affected by the change 👍

@arnaucasau arnaucasau added this pull request to the merge queue May 3, 2024
Merged via the queue into Qiskit:main with commit b0ecfa6 May 3, 2024
5 checks passed
@arnaucasau arnaucasau deleted the AC/remove-signature branch May 3, 2024 13:00
frankharkins pushed a commit to frankharkins/documentation that referenced this pull request Jul 22, 2024
This PR removes the signature prop from the Attribute component and
instead, sets `attributeTypeHint` and `attributeValue`. This change
simplifies the script that was using different props for attributes
embedded in the class page and the rest.

As a side effect, this PR also fixes an issue with some default values
not showing correctly. These values were treated as signatures and
wrongly converted into HTML by a unified plugin.

Closes Qiskit#1217 Qiskit#1252
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Get rid of signature with attributes Attributes with incomplete signatures for some versions of qiskit
3 participants