[tor-bugs] #25075 [- Select a component]: Constants are included in sphinx output

["Tor Bug Tracker & Wiki" <blackhole@xxxxxxxxxxxxxx>]

#25075: Constants are included in sphinx output
--------------------------------------+---------------------------
     Reporter:  atagar                |      Owner:  (none)
         Type:  defect                |     Status:  new
     Priority:  Low                   |  Milestone:
    Component:  - Select a component  |    Version:
     Severity:  Minor                 |   Keywords:  website, easy
Actual Points:                        |  Parent ID:
       Points:                        |   Reviewer:
      Sponsor:                        |
--------------------------------------+---------------------------
 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.

--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/25075>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online

_______________________________________________
tor-bugs mailing list
tor-bugs@xxxxxxxxxxxxxxxxxxxx
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs