Add diagram showing relationships between Ocean modules/classes
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 30/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- python
- Domain
- documentation
Research direction
No file, test, or entry point is named. Start by reviewing the Ocean documentation and its module and class structure, then define diagrams that show module layering and class inheritance; done means both relationship views are published in the documentation.
Written by the indexing model from the issue text.
Description
@spreinhardt 12:31 PM
Is there a diagram somewhere that shows how the different modules within Ocean are nested/layered on each other? And similarly for Classes, which ones are subclasses of others?
- Dominant language
- Python
- Stars
- 49
- Forks
- 28
- PR merge metrics
- No merged PRs in 30d
Contributor guide
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/docs
-
Difficulty 4/5 3-5 days Newbie friendliness 30/100
dwavesystems/docs#75 · 3 comments ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
dwavesystems/docs#74 · 2 comments ·
-
dwavesystems/docs#73 · 1 assignee ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 25/100
dwavesystems/docs#71 ·
-
Difficulty 1/5 1-3 hours Newbie friendliness 45/100
dwavesystems/docs#67 ·
All issues in dwavesystems/docs
Similar issues
-
essnmx good first issue
Difficulty 1/5 Under an hour Newbie friendliness 95/100
-
[Feature] 奇物选择添加优先级 Open
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
syfoud/Simulated_Scepter#174 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Giskard-AI/giskard-oss#2840 · 1 comment ·
-
A claim comment carrying the issue number is silently declined while the workflow reports success Openarea: repo bug perceived difficulty: 2
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
yeti-platform/yeti#1380 ·