Opened 15 months ago

Closed 7 weeks ago

#25075 closed defect (fixed)

Constants are included in sphinx output

Reported by: atagar Owned by: atagar
Priority: Low Milestone:
Component: Core Tor/Stem Version:
Severity: Minor Keywords: website easy
Cc: Actual Points:
Parent ID: Points:
Reviewer: Sponsor:

Description

As pointed out by Tim at the end of #25046 Sphinx is including our internal parser constants in its generated api docs...

https://stem.torproject.org/api/descriptor/networkstatus.html#stem.descriptor.networkstatus.NetworkStatusDocumentV3.content

HEADER_PARSER_FOR_LINE = {'valid-after': <function _parse at 0x7fba0426e488>, ...

Marking this with the 'easy' keyword since it's a good one for newcomers to bite off. I suspect that if we mark these constants as private with a leading underscore Sphinx might skip it. If not we'll need to investigate Sphinx a little more to figure out how to exclude these.

Child Tickets

Change History (5)

comment:1 Changed 15 months ago by arma

Component: - Select a componentCore Tor/Stem
Owner: set to atagar

(taking a guess at an appropriate component)

comment:2 Changed 15 months ago by atagar

Oops! Shame on me - thanks Roger.

comment:3 Changed 12 months ago by atagar

Keywords: website, easywebsite easy

comment:4 Changed 7 weeks ago by hannelores

Please review this change. Adding the leading underscores seemed to do the trick.
https://github.com/torproject/stem/pull/10

comment:5 Changed 7 weeks ago by atagar

Resolution: fixed
Status: newclosed
Note: See TracTickets for help on using tickets.