Contrib folder update #167
Conversation
Well, the ".egg-info" folder is not versioned and it seems to be generated when installing mistletoe via |
I guess this is OK. I have found that the |
There was a problem hiding this comment.
@anderskaplan, thank you! I think it looks fine, just some smaller amendments left. :)
Also, I expect that I can probably squash all the commits into one on merge, while adding issue link (#101) to the commit message, OK?
|
Comments addressed, should be good to go now!
|
|
@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? :) |
pbodnar
added
the
breaking-change
|
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. |
…toe project mistletoe gets new updates in its original Git repository again, so we can safely switch to that one now. This also means using updated paths to mistletoe's renderers from the "contrib" folder (see miyuchina/mistletoe#167).
…ke the contrib directory a python module. Updated imports in test_contrib.
Co-authored-by: Petr Bodnár <p.bodnar@centrum.cz>
anderskaplan
force-pushed
the
contrib-folder-update
branch
from
b5313f6
to
8ceadc0
Compare
|
Rebased to resolve a merge conflict. |
|
Hi @anderskaplan, thank you, so I have merged it right away. :) |
…toe project (#62) mistletoe gets new updates in its original Git repository again, so we can safely switch to that one now. This also means using updated paths to mistletoe's renderers from the "contrib" folder (see miyuchina/mistletoe#167).
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.