Skip to content

Commit

Permalink
📝 Better docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ThatXliner committed May 2, 2021
1 parent 074eb76 commit b5f8f94
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -225,4 +225,19 @@ If you really need to, you may also modify `DEFAULT_TAG_ALIASES`. Be warned: if

##### Utility functions when overriding

TK.
You may use (when extending) the following functions:

- `__parse`, 2 parameters:
- `html`: *bs4.BeautifulSoup*
- The html to unmark. This is used internally by the `unmark` method and is slightly faster.
- `escape`: *bool*
- Whether to escape the characters inside the string or not. Defaults to `False`.
- `escape`: 1 parameter:
- `string`: *str*
- The string to escape and make markdown-safe
- `wrap`: 2 parameters:
- `element`: *bs4.BeautifulSoup*
- The element to wrap.
- `around_with`: *str*
- The character to wrap the element around with. **WILL NOT BE ESCPAED**
- And, of course, `tag_*` and `detect_language`.

0 comments on commit b5f8f94

Please sign in to comment.