Skip to content

📚 DOCS: Fix parameter-names and descriptions #173

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chrisjsewell merged 1 commit into from
Sep 10, 2021
Merged

📚 DOCS: Fix parameter-names and descriptions #173

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions markdown_it/ruler.py
View file
Open in desktop
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