Package edu.hm.hafner.analysis.parser.pylint

Class PyLintDescriptions

java.lang.Object

edu.hm.hafner.analysis.parser.pylint.PyLintDescriptions

public class PyLintDescriptions
extends Object

Provides descriptions for all pylint rules.

Constructor Summary

Constructors

Constructor	Description
PyLintDescriptions()	Loads the available rules into a map.

Method Summary

Modifier and Type	Method	Description
String	getDescription(String name)	Returns the description of PyLint rule with the specified name.
int	size()	Returns the size of this messages cache.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PyLintDescriptions

public PyLintDescriptions()

Loads the available rules into a map.

Method Details

size

public int size()

Returns the size of this messages cache.

Returns:

the number of stored messages (English locale)

getDescription

public String getDescription(String name)

Returns the description of PyLint rule with the specified name.

Parameters:

name - the name of the rule, like 'missing-docstring'

Returns:

the description for the specified rule