Project

General

Profile

Actions
Copy link

Bug #19926

closed

Python SDK reverses option 1 / option 2 between "install" and "test" sections

Added by Peter Amstutz almost 2 years ago. Updated almost 2 years ago.

Status:
Resolved
Priority:
Normal
Assigned To:
Brett Smith
Category:
Documentation
Target version:
2023-02-15 sprint
Story points:
0.5
Release:
Arvados 2.6.0
Release relationship:
Auto

Description

https://doc.arvados.org/v2.5/sdk/python/sdk-python.html

The install has option 1: OS package / option 2: pip

The test section refers to option 1: pip and then option 2: OS package

  1. Fix the ordering
  2. In the "test" section, put option 1 / option 2 under headings so it is more clear

Subtasks 1 (0 open — 1 closed)

Task #20050: Review 19926-pysdk-install-docs-fixResolvedStephen Smith02/02/2023Actions
Actions
Copy link
 #1

Updated by Peter Amstutz almost 2 years ago

  • Description updated (diff)
Actions
Copy link
 #2

Updated by Peter Amstutz almost 2 years ago

  • Story points set to 0.5
Actions
Copy link
 #3

Updated by Peter Amstutz almost 2 years ago

  • Target version changed from To be scheduled to 2023-02-15 sprint
Actions
Copy link
 #4

Updated by Peter Amstutz almost 2 years ago

  • Assigned To set to Brett Smith
Actions
Copy link
 #5

Updated by Brett Smith almost 2 years ago

19926-pysdk-install-docs-fix @ c260a7641679548fbb3623206a9950bb5e0a4dec

I went further than the ticket said, I went ahead and flattened the whole page so each install section includes its own install steps, test steps, and then directs you to further documentation. This way readers don't have to keep alternating between sections they skip and sections they read. I did it in like 30 minutes so still well under the estimated time.

Actions
Copy link
 #6

Updated by Brett Smith almost 2 years ago

  • Status changed from New to In Progress
Actions
Copy link
 #7

Updated by Stephen Smith almost 2 years ago

This lgtm!

Actions
Copy link
 #8

Updated by Brett Smith almost 2 years ago

  • Status changed from In Progress to Resolved
Actions
Copy link
 #9

Updated by Peter Amstutz almost 2 years ago

  • Release set to 57
Actions
Copy link

Also available in: Atom PDF