Skip to content

Commit

Permalink
📚 DOCS: Fix parameter-names and descriptions (#173)
Browse files Browse the repository at this point in the history
this corrects the docstrings of some of class Ruler's methods
  • Loading branch information
marcusatiliusregulus authored Sep 10, 2021
1 parent 42e5732 commit cde6906
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions markdown_it/ruler.py
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ def __compile__(self) -> None:
def at(self, ruleName: str, fn: RuleFunc, options=None):
"""Replace rule by name with new function & options.
:param name: rule name to replace.
:param ruleName: rule name to replace.
:param fn: new rule function.
:param options: new rule options (not mandatory).
:raises: KeyError if name not found
Expand Down Expand Up @@ -135,8 +135,8 @@ def before(self, beforeName: str, ruleName: str, fn: RuleFunc, options=None):
def after(self, afterName: str, ruleName: str, fn: RuleFunc, options=None):
"""Add new rule to chain after one with given name.
:param beforeName: new rule will be added before this one.
:param ruleName: new rule will be added before this one.
:param afterName: new rule will be added after this one.
:param ruleName: new rule will be added after this one.
:param fn: new rule function.
:param options: new rule options (not mandatory).
:raises: KeyError if name not found
Expand All @@ -153,7 +153,7 @@ def after(self, afterName: str, ruleName: str, fn: RuleFunc, options=None):
def push(self, ruleName: str, fn: RuleFunc, options=None):
"""Push new rule to the end of chain.
:param ruleName: new rule will be added before this one.
:param ruleName: new rule will be added to the end of chain.
:param fn: new rule function.
:param options: new rule options (not mandatory).
Expand Down

0 comments on commit cde6906

Please sign in to comment.