Composites show as being under the __init__ module
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 48/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- documentation
Research direction
Locate the documentation source containing the .. automodule:: dwave.preprocessing.composites.__init__ directive and inspect how the composites are presented. Rebuild the affected API documentation and verify that the composites appear under the intended module and that the generated objects.inv supports the expected cross-references.
Written by the indexing model from the issue text.
Description
The built docs show currently like this:
This is due to the placement of the .. automodule:: dwave.preprocessing.composites.__init__ directive, and it causes a problem for xrefing:
The objects.inv looks like this:
- Dominant language
- C++
- Stars
- 9
- Forks
- 18
- PR merge metrics
- No merged PRs in 30d
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.
More from dwavesystems/dwave-preprocessing
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
dwavesystems/dwave-preprocessing#134 · 1 comment ·
-
enhancement
Difficulty 5/5 Over a week Newbie friendliness 25/100
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
-
enhancement
Difficulty 3/5 1-2 days Newbie friendliness 45/100
All issues in dwavesystems/dwave-preprocessing
Similar issues
-
enhancement
Difficulty 1/5 Under an hour Newbie friendliness 88/100
QuantStack/git2cpp#187 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
mlcommons/mobile_app_open#1182 ·
-
Needs-Triage
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
microsoft/winget-cli#6547 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
AXERA-TECH/ax-llm#77 ·