+ docstring for import_bibtex( )

GetRD / academic-file-converter

📚 Import Bibtex publications and Jupyter Notebook blog posts into your Markdown website or book. 将Bibtex转换为Markdown网站

https://docs.hugoblox.com/reference/content-types/#automatically-import-publications-from-bibtex

MIT License

356 stars 101 forks source link

+ docstring for import_bibtex( ) #95

Closed 7yl4r closed 3 years ago

7yl4r commented 3 years ago

I was looking at the code frustrated at the lack of docs until I saw the README. It is probably worth including this docstring alongside the function.

gcushen commented 3 years ago

Your comment mentions how to run the CLI tool, and as such might be better suited as a comment in the CLI module: https://github.com/wowchemy/hugo-academic-cli/blob/93acb29fd7833d3932868bf96875f284a4dabcb5/academic/cli.py#L29

Separately, it might be a good idea for contributors to refactor the tool to be more OOP so that functions can inherit the flags rather than feeding them from one function to the next...

github-actions[bot] commented 3 years ago

This PR is stale because it has not had any recent activity. The resources of the project maintainers are limited, and so we are asking for your help.

If you feel that the PR is still relevant in the latest release, consider making the PR easier to review and finding developers to help review the PR.

Please be mindful that although we encourage PRs, we cannot expand the scope of the project in every possible direction. There will be requests that don't make the roadmap.

This PR will automatically close soon if no further activity occurs. Thank you for your contributions.