Docs: Standardize C API documentation pages for QkBitTerm, QkExitCode, and QkNeighbors#15828
Docs: Standardize C API documentation pages for QkBitTerm, QkExitCode, and QkNeighbors#15828ferasshita wants to merge 3 commits intoQiskit:mainfrom
Conversation
…-code) Co-authored-by: ferasshita <50782399+ferasshita@users.noreply.github.com>
docs(cdoc): fix grammar, heading level, and missing section in C API pages
|
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:
|
|
|
There was a problem hiding this comment.
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
Functionsheading adornment inqk-neighbors.rst. - Add a
Functionssection header toqk-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.
|
|
||
| Functions | ||
| --------- |
Summary
Standardize and improve formatting in C API documentation pages under
docs/cdoc/:qk-bit-term.rst(“An enum that to represent…” → “An enum that represents…”)qk-neighbors.rstqk-exit-code.rstDetails and comments