Skip to content

Docs: Standardize C API documentation pages for QkBitTerm, QkExitCode, and QkNeighbors#15828

Open
ferasshita wants to merge 3 commits intoQiskit:mainfrom
ferasshita:main
Open

Docs: Standardize C API documentation pages for QkBitTerm, QkExitCode, and QkNeighbors#15828
ferasshita wants to merge 3 commits intoQiskit:mainfrom
ferasshita:main

Conversation

@ferasshita
Copy link

Summary

Standardize and improve formatting in C API documentation pages under docs/cdoc/:

  • Fix grammar in qk-bit-term.rst (“An enum that to represent…” → “An enum that represents…”)
  • Make "Functions" heading level consistent in qk-neighbors.rst
  • Add missing "Functions" section to qk-exit-code.rst

Details and comments

  • Only documentation files were changed.
  • All changes follow the guidelines for documentation consistency and accessibility.
  • No behavioral changes to code or API.
  • AI tool used: Microsoft Copilot Chat with GPT-4

Copilot AI and others added 3 commits March 17, 2026 22:19
…-code)

Co-authored-by: ferasshita <50782399+ferasshita@users.noreply.github.com>
docs(cdoc): fix grammar, heading level, and missing section in C API pages
@ferasshita ferasshita requested a review from a team as a code owner March 17, 2026 22:36
Copilot AI review requested due to automatic review settings March 17, 2026 22:36
@qiskit-bot qiskit-bot added the Community PR PRs from contributors that are not 'members' of the Qiskit repo label Mar 17, 2026
@qiskit-bot
Copy link
Collaborator

Thank you for opening a new pull request.

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.

While you're waiting, please feel free to review other open PRs. While only a subset of people are authorized to approve pull requests for merging, everyone is encouraged to review open pull requests. Doing reviews helps reduce the burden on the core team and helps make the project's code better for everyone.

One or more of the following people are relevant to this code:

  • @Qiskit/terra-core

@CLAassistant
Copy link

CLAassistant commented Mar 17, 2026

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ ferasshita
❌ Copilot
You have signed the CLA already but the status is still pending? Let us recheck it.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR standardizes formatting across several C API documentation pages under docs/cdoc/, primarily by fixing grammar and aligning section structure/headings for consistency in the generated Sphinx docs.

Changes:

  • Fix grammar in qk-bit-term.rst (“An enum that to represent…” → “An enum that represents…”).
  • Adjust the Functions heading adornment in qk-neighbors.rst.
  • Add a Functions section header to qk-exit-code.rst.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
docs/cdoc/qk-neighbors.rst Changes the Functions heading underline style for consistency.
docs/cdoc/qk-exit-code.rst Adds a Functions section header after the enum values list.
docs/cdoc/qk-bit-term.rst Fixes a grammar issue in the enum description sentence.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

Comment on lines +48 to +50

Functions
---------
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Community PR PRs from contributors that are not 'members' of the Qiskit repo

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

5 participants