I'm wondering if this should appear in a docstirng for a function rather than in-code comments so it is scraped by Sphinx.