Actions
Bug #21136
closedFix type name collision in pdoc's rendering of api_resources
Status:
Resolved
Priority:
Normal
Assigned To:
Category:
Documentation
Target version:
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:
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
Updated by Brett Smith about 1 year 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
Updated by Brett Smith about 1 year ago
- % Done changed from 0 to 100
- Status changed from In Progress to Resolved
Applied in changeset arvados|75aee7b3d5b6c8e84e25e71eefe88040d8a12022.
Actions