Details
-
Type:
Story
-
Status: Done
-
Resolution: Done
-
Fix Version/s: None
-
Labels:None
-
Story Points:0.5
-
Epic Link:
-
Team:SQuaRE
-
Urgent?:No
Description
While trialing Sphinx 3.2-based pipelines.lsst.io documentation builds, I found that a few See also docstring sections in afw and ip_isr were breaking the Sphinx builds, presumably due to more stringent requirements. The main issue is adding () to the function names; the See also section can only contain the actual API name.
Attachments
Issue Links
- relates to
-
DM-26768 Unpin Documenteer's sphinx extensions and test against representative downstream users
- Done
Activity
Field | Original Value | New Value |
---|---|---|
Epic Link |
|
Status | To Do [ 10001 ] | In Progress [ 3 ] |
Summary | Fix docstring See also references in | Fix docstring See also references in afw and ip_isr |
Component/s | afw [ 10714 ] | |
Component/s | ip_isr [ 10730 ] |
Story Points | 0.5 |
Resolution | Done [ 10000 ] | |
Status | In Progress [ 3 ] | Done [ 10002 ] |