python-markdown-generator icon indicating copy to clipboard operation
python-markdown-generator copied to clipboard

confusing function naming

Open autosquid opened this issue 1 year ago • 3 comments

Hi, thanks for the nice library. I'm using it to generate some md docs and then using reveal.js to host a mini-web of slides.

I'm wondering if it would be nicer if make the lib more functional by touching function names a bit, to rename some of the functions from addXXX(write_to_fle = false) to get_xxx() and return the markdown raw string instead.

autosquid avatar Feb 03 '23 15:02 autosquid

This is a great suggestion. The API should be redesigned and "write_to_file" is a bit clunky approach. I don't remember the exact benefits anymore. However, I am a bit busy at the moment and I personally don't need the library at moment, so I can't afford too much time for it. But library is not that big, so maybe redesign could be done over one weekend...

Nicceboy avatar Feb 13 '23 16:02 Nicceboy

@autosquid if you want to work on doing a patch or have questions I can help you submit a PR. @Nicceboy this is a great reop thanks for making it

datatalking avatar May 08 '23 19:05 datatalking

Sure, I'll try to submit a patch (later).

autosquid avatar May 25 '23 09:05 autosquid