Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

confusing function naming #6

Open
autosquid opened this issue Feb 3, 2023 · 3 comments
Open

confusing function naming #6

autosquid opened this issue Feb 3, 2023 · 3 comments

Comments

@autosquid
Copy link

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.

@Nicceboy
Copy link
Owner

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...

@datatalking
Copy link

@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

@autosquid
Copy link
Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants