Project

General

Profile

Actions

Bug #22079

closed

PySDK reference needs references to iter_computed_permissions

Added by Brett Smith 3 months ago. Updated 3 months ago.

Status:
Resolved
Priority:
Normal
Assigned To:
Category:
SDKs
Story points:
-
Release:
Release relationship:
Auto

Description

sdk/python/discovery2pydoc.py adds some generic text to list method documentation to point people to arvados.util.keyset_list_all and suggest they should probably use that instead.

This is not correct for ComputedPermssions.list and any other methods that work on computed permissions. There, the text needs to be updated to point the reader to arvados.util.iter_computed_permissions instead.

This will require some sort of special-casing or templating of the current text, since right now it's purely a static blob.


Subtasks 1 (0 open1 closed)

Task #22129: Review 22079-pysdk-reference-bugfixesResolvedBrett Smith09/17/2024Actions
Actions #1

Updated by Brett Smith 3 months ago

  • Status changed from New to In Progress
Actions #2

Updated by Brett Smith 3 months ago

  • Target version set to Development 2024-09-25 sprint
  • Assigned To set to Brett Smith

22079-pysdk-reference-bugfixes @ 0fe61ab3321d0b1542a535874d595bb0279178ea - developer-run-tests: #4447

This branch includes fixes for both #22079 and #22126, along with a couple other bugs in the script that are so minor they don't have issues.

  • All agreed upon points are implemented / addressed.
    • Yes
  • Anything not implemented (discovered or discussed during work) has a follow-up story.
    • N/A
  • Code is tested and passing, both automated and manual, what manual testing was done is described
    • See above. Also reviewed the generated documentation manually to confirm all fixes took as expected.
  • Documentation has been updated.
    • N/A
  • Behaves appropriately at the intended scale (describe intended scale).
    • No change in scale
  • Considered backwards and forwards compatibility issues between client and server.
    • No change
  • Follows our coding standards and GUI style guidelines.
    • Yes
Actions #3

Updated by Lucas Di Pentima 3 months ago

This LGTM, thanks!

Actions #4

Updated by Brett Smith 3 months ago

  • Status changed from In Progress to Resolved
Actions #5

Updated by Peter Amstutz 3 months ago

  • Release set to 70
Actions

Also available in: Atom PDF