dwavesystems / dwavesystems/dwave-ocean-sdk

Remove "release" under the various package's reference documentation

Open
#56 1 comment 0 reactions 0 assignees View on GitHub
docs
Dominant language
Python
Stars
539
Forks
192
Avg merge
1d 2h
Merged PRs (30d)
2

Description

E.g. for dimod
![dimod reference version](https://user-images.githubusercontent.com/8395238/74271115-3502da80-4cc1-11ea-81d0-09598f55a9ce.jpg)

but that version refers to the sdk version _not_ the dimod version. In the dimod (et al) specific parts of the documentation it would be less confusing to simply remove it.

Contributor guide

Open the contributing guide

Research direction

Start by locating the various packages' reference documentation, using the dimod reference page and the attached screenshot as the example. Remove the misleading “release” entry from package-specific reference pages, then build or inspect the documentation to confirm those entries are gone while the SDK release information remains where appropriate.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.