Details
-
Type:
Story
-
Status: Done
-
Resolution: Done
-
Fix Version/s: None
-
Component/s: ts_middleware
-
Labels:
-
Story Points:1
-
Epic Link:
-
Sprint:TSSW Sprint - Jan 02 - Jan 16, TSSW Sprint - Jan 16 - Jan 30
-
Team:Telescope and Site
-
Urgent?:No
Description
Modernize type annotations to use | instead of typing.Optional and typing.Union, etc.
I also tried modernize the doc build to use documenteer[guide] in ts_utils. This is an experiment to try out the modern documenteer that can generate type information for parameters (but not yet return values) from type annotations. That is on tag "documenteer-guide" but we decided not to include it in this ticket.
Attachments
Issue Links
- relates to
-
- To Do
Activity
| Field | Original Value | New Value |
|---|---|---|
| Description |
Modernize the doc build to use documenteer[guide] in ts_utils. This is an experiment to try out the modern documenteer that can generate type information for parameters (but not yet return values) from type annotations.
and modernize type annotations to use | instead of typing.Optional and typing.Union, etc. |
Modernize the doc build to use documenteer[guide] in ts_utils. This is an experiment to try out the modern documenteer that can generate type information for parameters (but not yet return values) from type annotations.
and modernize type annotations to use | instead of typing.Optional and typing.Union, etc. This is primarily intended as a proof of concept and to learn how to use documenteer[guide]. |
| Epic Link | DM-32120 [ 770392 ] | |
| Sprint | TSSW Sprint - Jan 02 - Jan 16 [ 1211 ] |
| Status | To Do [ 10001 ] | In Progress [ 3 ] |
| Reviewers | Eric Coughlin [ ecoughlin ] | |
| Status | In Progress [ 3 ] | In Review [ 10004 ] |
Eric Coughlin
made changes -
| Status | In Review [ 10004 ] | Reviewed [ 10101 ] |
| Sprint | TSSW Sprint - Jan 02 - Jan 16 [ 1211 ] | TSSW Sprint - Jan 02 - Jan 16, TSSW Sprint - Jan 16 - Jan 30 [ 1211, 1212 ] |
| Summary | Modernize doc build and type annotations in ts_utils | Modernize type annotations in ts_utils and simplify ImageNameServiceClient |
| Description |
Modernize the doc build to use documenteer[guide] in ts_utils. This is an experiment to try out the modern documenteer that can generate type information for parameters (but not yet return values) from type annotations.
and modernize type annotations to use | instead of typing.Optional and typing.Union, etc. This is primarily intended as a proof of concept and to learn how to use documenteer[guide]. |
Modernize type annotations to use | instead of typing.Optional and typing.Union, etc.
I also tried modernize the doc build to use documenteer[guide] in ts_utils. This is an experiment to try out the modern documenteer that can generate type information for parameters (but not yet return values) from type annotations. That is on tag "documenteer-guide" but we decided not to include it in this ticket. |
| Resolution | Done [ 10000 ] | |
| Status | Reviewed [ 10101 ] | Done [ 10002 ] |