confusing error "Missing a blank line before epytext markups"

Bug #1093502 reported by Jean-Paul Calderone
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
twistedchecker
New
Undecided
Unassigned

Bug Description

This error is reported:

    W9207:927,4:FilePath.getInodeNumber: Missing a blank line before epytext markups

when getInodeNumber looks like this:

    def getInodeNumber(self):
        """
        Retrieve the file serial number, also called inode number, which
        distinguishes this file from all other files on the same device.

        @raise NotImplementedError: if the platform is Windows, since the
            inode number would be a dummy value for all files in Windows
        @return: a number representing the file serial number
        @rtype: L{int}
        @since: 11.0
        """

It's not really clear what the problem with this docstring is.

Related branches

Revision history for this message
wsanchez (wsanchez) wrote :

In checkers.docstring._checkBlankLineBeforeEpytext, patternEpytext is missing cvar and ivar. Of, for the above example, raise.

Here's my code that also fails here:

    @cvar defaultLogger: The default L{Logger} instance to use when none is
        supplied to L{LoggingFile.__init__}.
    @type defaultLogger: L{Logger}

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.