pip._vendor.pygments.filters.CodeTagFilter Class Reference

Inheritance diagram for pip._vendor.pygments.filters.CodeTagFilter:

Collaboration diagram for pip._vendor.pygments.filters.CodeTagFilter:

Public Member Functions
	__init__ (self, **options)
	filter (self, lexer, stream)

Public Attributes
	tag_re
Public Attributes inherited from pip._vendor.pygments.filter.Filter
	options

Detailed Description

Highlight special code tags in comments and docstrings.

Options accepted:

`codetags` : list of strings
   A list of strings that are flagged as code tags.  The default is to
   highlight ``XXX``, ``TODO``, ``FIXME``, ``BUG`` and ``NOTE``.

.. versionchanged:: 2.13
   Now recognizes ``FIXME`` by default.

Constructor & Destructor Documentation

__init__()

pip._vendor.pygments.filters.CodeTagFilter.__init__	(		self,
		**	options
	)

Reimplemented from pip._vendor.pygments.filter.Filter.

Member Function Documentation

filter()

pip._vendor.pygments.filters.CodeTagFilter.filter	(		self,
			lexer,
			stream
	)

Reimplemented from pip._vendor.pygments.filter.Filter.

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/pip/_vendor/pygments/filters/__init__.py