Skip to content

Commit cde6906

Browse files
author
marcusatiliusregulus
authored
📚 DOCS: Fix parameter-names and descriptions (#173)
this corrects the docstrings of some of class Ruler's methods
1 parent 42e5732 commit cde6906

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

markdown_it/ruler.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ def __compile__(self) -> None:
103103
def at(self, ruleName: str, fn: RuleFunc, options=None):
104104
"""Replace rule by name with new function & options.
105105
106-
:param name: rule name to replace.
106+
:param ruleName: rule name to replace.
107107
:param fn: new rule function.
108108
:param options: new rule options (not mandatory).
109109
:raises: KeyError if name not found
@@ -135,8 +135,8 @@ def before(self, beforeName: str, ruleName: str, fn: RuleFunc, options=None):
135135
def after(self, afterName: str, ruleName: str, fn: RuleFunc, options=None):
136136
"""Add new rule to chain after one with given name.
137137
138-
:param beforeName: new rule will be added before this one.
139-
:param ruleName: new rule will be added before this one.
138+
:param afterName: new rule will be added after this one.
139+
:param ruleName: new rule will be added after this one.
140140
:param fn: new rule function.
141141
:param options: new rule options (not mandatory).
142142
:raises: KeyError if name not found
@@ -153,7 +153,7 @@ def after(self, afterName: str, ruleName: str, fn: RuleFunc, options=None):
153153
def push(self, ruleName: str, fn: RuleFunc, options=None):
154154
"""Push new rule to the end of chain.
155155
156-
:param ruleName: new rule will be added before this one.
156+
:param ruleName: new rule will be added to the end of chain.
157157
:param fn: new rule function.
158158
:param options: new rule options (not mandatory).
159159

0 commit comments

Comments
 (0)