Project

General

Profile

Actions

Bug #21136

closed

Fix type name collision in pdoc's rendering of api_resources

Added by Brett Smith about 1 month ago. Updated 3 days ago.

Status:
Resolved
Priority:
Normal
Assigned To:
Category:
Documentation
Start date:
Due date:
% Done:

100%

Estimated time:
Story points:
0.5

Description

discovery2pydoc.py writes the signature of Links.update like this:

    def update(self, *, uuid: 'str', select: 'list') -> 'Link':

pdoc renders it like this. Note the type of the select argument:

pdoc signature for Links.update

Update discovery2pydoc.py so that pdoc understands that 'list' refers to the builtin and not Links.list.

This might require moving away from all-strings annotations and actually using the intended objects. If you go that route, be careful about version compatibility. You might need to go all the way to pulling in the typing versions of List, Dict, etc.


Files

clipboard-202310201213-dxqxa.png (26.7 KB) clipboard-202310201213-dxqxa.png pdoc signature for Links.update Brett Smith, 10/20/2023 04:13 PM
Actions #1

Updated by Brett Smith 13 days ago

  • Target version changed from To be scheduled to Development 2023-11-29 sprint
  • Assigned To set to Brett Smith
  • Status changed from New to In Progress
Actions #2

Updated by Brett Smith 9 days ago

  • % Done changed from 0 to 100
  • Status changed from In Progress to Resolved
Actions

Also available in: Atom PDF