File tree Expand file tree Collapse file tree 2 files changed +13
-1
lines changed
Expand file tree Collapse file tree 2 files changed +13
-1
lines changed Original file line number Diff line number Diff line change @@ -31,7 +31,7 @@ This chapter provides a plain reference for the XRLint Python API.
3131 [ Processor] [ xrlint.processor.Processor ] comprising processor metadata
3232 [ ProcessorMeta] [ xrlint.processor.ProcessorMeta ]
3333 and the processor operation [ ProcessorOp] [ xrlint.processor.ProcessorOp ] .
34- Decorator [ define_processor] [ xrlint.rule.define_rule ] allows defining
34+ Decorator [ define_processor] [ xrlint.processor.define_processor ] allows defining
3535 processors.
3636- The ` result ` module provides data classes that are used to
3737 represent validation results:
Original file line number Diff line number Diff line change @@ -56,6 +56,12 @@ def define_rule(
5656 docs_url : str | None = None ,
5757 op_class : Type [RuleOp ] | None = None ,
5858 ) -> Callable [[Any ], Type [RuleOp ]] | None :
59+ """Decorator to define a plugin rule.
60+ The method registers a new rule with the plugin.
61+
62+ Refer to [define_rule][xrlint.rule.define_rule]
63+ for details.
64+ """
5965 return define_rule (
6066 name = name ,
6167 version = version ,
@@ -73,6 +79,12 @@ def define_processor(
7379 version : str = "0.0.0" ,
7480 op_class : Type [ProcessorOp ] | None = None ,
7581 ):
82+ """Decorator to define a plugin processor.
83+ The method registers a new processor with the plugin.
84+
85+ Refer to [define_processor][xrlint.processor.define_processor]
86+ for details.
87+ """
7688 return define_processor (
7789 name = name ,
7890 version = version ,
You can’t perform that action at this time.
0 commit comments