Contrib folder update - Githubissues

miyuchina / mistletoe

A fast, extensible and spec-compliant Markdown parser in pure Python.

MIT License

811 stars 113 forks source link

Contrib folder update #167

Closed anderskaplan closed 1 year ago

anderskaplan commented 1 year ago

This PR is a proposed solution for #101, Make renderers from the "contrib" folder easier to use. The approach taken is as described in the discussion thread on that issue: basically to move the contrib directory inside the mistletoe source directory.

In addition to moving files around, the PR also includes some documentation updates to explain the use of the contrib folder and how to use the renderers in the contrib directory from the CLI.

NOTE the mistletoe.egg-info folder has not been updated, as the egg format seems to be quite obsolete by now and superseeded by wheel. I'd recommend to remove the egg-info folder.

pbodnar commented 1 year ago

NOTE the mistletoe.egg-info folder has not been updated, as the egg format seems to be quite obsolete by now and superseeded by wheel. I'd recommend to remove the egg-info folder.

Well, the ".egg-info" folder is not versioned and it seems to be generated when installing mistletoe via pip3 install -e .. So no problem here, actually? :)

pbodnar commented 1 year ago

... Added init.py to make the contrib directory a python module. ...

I guess this is OK. I have found that the __init__.py file is no longer necessary since Python 3.3, yet it seems to be recommended for "regular packages", like this one - as described at SO?

anderskaplan commented 1 year ago

Comments addressed, should be good to go now!

The ".egg-info" folder is not versioned: yeah you're right. It's not a problem that the file list needs to be updated, then. Good.
Agree that the recommendation seems to be to keep the init for packages.
Updates applied to the README: the ones you pointed out plus a few more that I spotted when searching for "contrib".
Squash merge is fine with me.

pbodnar commented 1 year ago

@anderskaplan, LGTM, thank you!

I just have to prepare a PR for changing https://github.com/hluk/copyq-commands/blob/master/Global/convert-markdown.ini which uses the renderers from the contrib folder, and I will merge this afterwards.

Also, what do you think about including this "breaking change" (not much we can do to keep it backwards compatible at least for a while, I guess) into version 1.0.0 - yes, or no? :)

anderskaplan commented 1 year ago

Hi @pbodnar, as you say there's not much that can be done to keep this backward compatible, so I thinks its better to rip off the band-aid as soon as possible and be done with it. Besides, the label "contrib" indicates that the software is more experimental and that a lower standard of backward compatibility is to be expected.

anderskaplan commented 1 year ago

Rebased to resolve a merge conflict.

pbodnar commented 1 year ago

Hi @anderskaplan, thank you, so I have merged it right away. :)