[DM-26826] Fix docstring See also references in afw and ip_isr - Jira

XML

Word

Printable

Details

Type: Story
Status: Done
Resolution: Done
Fix Version/s: None
Component/s: afw, ip_isr
Labels:
None

Story Points:
0.5
Epic Link:
sqre-f20-doceng-1
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

Ascending order - Click to sort in descending order

Jonathan Sick created issue - 21/Sep/20 6:43 PM

Jonathan Sick made changes - 21/Sep/20 6:43 PM

Field	Original Value	New Value
Epic Link		~~DM-25248~~ [ 435569 ]

Jonathan Sick made changes - 21/Sep/20 6:43 PM

Link

This issue relates to ~~DM-26768~~ [ ~~DM-26768~~ ]

Jonathan Sick made changes - 21/Sep/20 6:55 PM

Status

To Do [ 10001 ]

In Progress [ 3 ]

Jonathan Sick made changes - 21/Sep/20 7:54 PM

Summary

Fix docstring See also references in

Fix docstring See also references in afw and ip_isr

Jonathan Sick made changes - 21/Sep/20 7:54 PM

Component/s		afw [ 10714 ]
Component/s		ip_isr [ 10730 ]

Jonathan Sick made changes - 21/Sep/20 8:02 PM

Story Points

0.5

Jonathan Sick made changes - 21/Sep/20 8:02 PM

Resolution		Done [ 10000 ]
Status	In Progress [ 3 ]	Done [ 10002 ]

People

Assignee:: Jonathan Sick

Reporter:: Jonathan Sick

Watchers:: Jonathan Sick

Votes:: 0 Vote for this issue

Watchers:: 1 Start watching this issue

Dates

Created:: 21/Sep/20 6:43 PM

Updated:: 21/Sep/20 8:02 PM

Resolved:: 21/Sep/20 8:02 PM

Jenkins

No builds found.

Data Management