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

Document example implementations of metadata extractors #383

Open
mih opened this issue Jul 19, 2023 · 0 comments
Open

Document example implementations of metadata extractors #383

mih opened this issue Jul 19, 2023 · 0 comments

Comments

@mih
Copy link
Member

mih commented Jul 19, 2023

http://docs.datalad.org/projects/metalad/en/latest/user_guide/writing-extractors.html nicely documents the purpose of each API component. However, the provided example implementations (which people like me will C&P) are undocumented. This will lead to the duplication of work (everyone needs to add comments), or -- much more likely -- the proliferation of undocumented code.

I think the information from the docs should also be present in the example implementations.

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

1 participant