add_render_rule should give some kind of warning for attempting to add a rule with a non-existant name.

[MisterEggnog]

Context

While working on a plugin for markdown_it I did not understand the purpose of the name argument to MarkdownIt.add_render_rule, this was not helped that as best I could tell said argument had no clear purpose, (the fact that the docstring gives no information does not help either,) because of this I spent time troubleshooting why my rule was never being invoked.

Proposal

The simplest solution I think would be to include in add_render_rule or whatever part in the code that lookups the name, to log a warning if name is not one of the preset rules. I think pythons logger.warning would likely be suitable for this.

It may also be helpful to note that name must be a preset rule in the docstring for MarkdownIt.add_render_rule.

Tasks and updates

No response

[welcome]

Thanks for opening your first issue here! Engagement like this is essential for open source projects! 🤗

If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.

If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).

Welcome to the EBP community! 🎉