SEO: API metadata description should probably include the package name
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 106
- Forks
- 223
- Avg merge
- 1d 8h
- Merged PRs (30d)
- 72
Description
Follow up to https://github.com/Qiskit/documentation/pull/2241. The Addons team thinks it would be helpful to include the full product name from Pkg.ts, whereas currently we only use the PyPI package name:
Update: should be
API reference for qiskit_addon_cutting.qpd in the latest version of Qiskit Addon Cutting ('qiskit-addon-cutting')
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with docs/api/qiskit-addon-cutting/qpd.mdx at the referenced description line and compare it with the product name in Pkg.ts. Update the API metadata description to include the full Qiskit Addon Cutting name and verify the rendered API page shows the requested wording.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100