Ticket #914 (closed task: fixed)

Opened 5 years ago

Last modified 5 years ago

normalize pydoc indentation

Reported by: ArcRiley Owned by: JonNeal
Priority: Low Milestone: beta3
Component: unknown Version: Trunk
Keywords: Documentation Cc:

Description

Different Pydoc indentation methods are being used throughout the code, which makes the help() display (and soon website docs) inconsistent. Normalize all the pydoc strings to this format:

cdef class Example :
  '''No Space Before Short Desc, followed by blank line:

    Long description is indented four spaces and wrapped at 80 colums
    and then closing ''' on a line by itself indented to the same level as the opening
  '''
 
  property another :
    '''Another Example

    Still indented four spaces, just as above, because we're in multi-line string.
    '''

Change History

comment:1 Changed 5 years ago by JonNeal

  • Owner changed from ArcRiley to JonNeal

comment:2 Changed 5 years ago by JonNeal

  • Status changed from new to assigned

comment:3 Changed 5 years ago by JonNeal

  • Status changed from assigned to closed
  • Resolution set to fixed
Note: See TracTickets for help on using tickets.