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

Improve etnservice function documentation and examples #31

Open
PietrH opened this issue Jun 12, 2023 · 0 comments
Open

Improve etnservice function documentation and examples #31

PietrH opened this issue Jun 12, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@PietrH
Copy link
Member

PietrH commented Jun 12, 2023

Currently the function documentation (roxygen) within etnservice is the same as it was on etn, except for the adapted parameter credentials which replaces connection. The examples haven't been changed at all (so will not work).

This documentation is currently not user facing, as etn uses it's own sql helper and roxygen documentation (see inbo/etn#280). Meaning that the database interfacing code needs to be maintained in two places. However, we are considering reducing this to one place by making etnservice a dependency of etn and using/evaluating/parsing the code from etnservice for use in the database interfacing functions of etn.

In short, either we should update the documentation in etnservice to be more userfriendly for future collaborators, or we should update it to be correct and client facing once more, so it can be inherited by etn.

@PietrH PietrH added the documentation Improvements or additions to documentation label Jun 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant