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.

Sign up for GitHub

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

Jump to bottom

Auto-generate Importer-Exporter markdown templates #71

Open
athityakumar opened this issue Dec 7, 2017 · 1 comment
Open

Auto-generate Importer-Exporter markdown templates #71

athityakumar opened this issue Dec 7, 2017 · 1 comment
Labels
ready Repo setup

Comments

@athityakumar
Copy link
Member

As mentioned by @zverok in PR #64, the README seems to be quite crowded with examples and useful information of ALL Importer-Exporter modules. Rather, the corresponding links in the LOC in the README can be linked to corresponding module/{FORMAT}_IMPORTER.md. These module/{FORMAT}_IMPORTER.md can preferably be generated by a Rake task, via ERB templates.
@athityakumar athityakumar mentioned this issue Dec 7, 2017
Open
@zverok
Copy link
Collaborator

zverok commented Dec 8, 2017

In fact, my proposal was to have one doc/Importers.md file with all importers & autogenerated TOC. Source for it should/can be taken from lib/importers/importer_name.rb top comment block.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
ready Repo setup
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@zverok @athityakumar